Skip to main content
POST
Estimate credits

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.

Body

application/json

Request body of estimate_credits.

actions
object[]
required

1..20 actions, each of one kind, priced in the order given and summed.

Required array length: 1 - 20 elements
playtable_sid
string | null

The table (pt_tb_): required by a column_draft action (the grid its prompt is read on), optional otherwise.

Required string length: 18
Pattern: ^pt_tb_
object_type
enum<string> | null

people | company, the grid: required by a column_draft action.

Available options:
people,
company
rows

What the price covers: a count of rows (0..1000000), or the run's scope (object_sids XOR view_sid / filter, counted on ES). Omitted: a column action prices the whole table, a column_draft the grid's first rows, a unit one call.

Required range: 0 <= x <= 1000000

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