Skip to main content
POST
Purchase credits

Authorizations

Authorization
string
header
required

Access token issued by gtm.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 purchase_credits.

kind
enum<string>
required

Consumable family: MVP "enrichment".

Available options:
enrichment
amount
integer
required

Credits to buy.

Required range: x >= 1
request_id
string
required

Idempotency key; MUST be stable across retries. A new key = a second charge.

Maximum string length: 64

Response

action_async success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required
async
enum<boolean>
required
Available options:
true
item
object | null
required
pending
object[]
required
result
object
required
meta
object
required
credits
object