Skip to main content
POST
A short-lived token for one Workbot turn

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Body

application/json
ttlMs
integer
Required range: 60000 <= x <= 3600000
readOnly
boolean
sessionId
string
Required string length: 1 - 128
messageId
string
Required string length: 1 - 128
model
string
Required string length: 1 - 512
modelAccessRequired
boolean

Response

The token.

token
string
required
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
resumeGrant
string
modelAccess
object
indexCapability
string