Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A managed API key, sent as Authorization: Bearer <key>. A workspace key is prefixed tgcc_; a reseller key is prefixed tgpk_. Keys carry scopes; the scope each operation demands is on the operation as x-required-scope.

Headers

Idempotency-Key
string

A key of your own choosing, so a retry cannot create a second of anything. Replayable for 24 hours. An unfinished claim is released after 15 minutes, so a request that died mid-flight does not block its own retry.

Maximum string length: 255

Body

The keys below are the ones this handler reads, taken from its source rather than from a serializer — these endpoints validate by hand and have no serializer to generate from. Their types and which are required are not pinned by this document; the endpoint answers 400 with a message naming the problem. Treat that as a gap to be closed by the owning batch, not as licence to send anything.

idempotency_key
any
items
any
params
any
type
any

Response

Accepted. The work is queued: poll the job or the resource for its status rather than treating this as completion.