Skip to main content
Reserve an agent interaction

Authorizations

Authorization
string
header
required

Opaque control credential

Headers

Idempotency-Key
string
required
Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
hostedRunId
string
required
Pattern: ^hrun_[0-9a-z]{12,32}$

Body

application/json
interactionId
string
required
Required string length: 1 - 96
Pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
expectedRevision
integer
required
Required range: 0 < x <= 9007199254740991
runnerId
string
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$
simulationWorkId
string
Pattern: ^simwork_[0-9a-z]{12,32}$

Response

Original reservation receipt

claim
object
required
replayed
boolean
required