Skip to main content
POST
Estimate semantic index cost

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The column (pt_fd_…): a scalar_text column, or an action_ai_research column with output: text; any other type is 422 validation_failed.

Required string length: 18
Pattern: ^pt_fd_

Body

application/json

Request body of estimate_semantic_index.

provider
string
required

The embed provider the knob would carry, e.g. "openai". A pairing the platform catalog does not list is 422 relation_not_found, as on update.

Required string length: 1 - 64
model
string
required

The embed model, e.g. "text-embedding-3-small". An unreachable catalog is 503 service_unavailable: without the rate there is no honest number.

Required string length: 1 - 128

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required