Skip to main content
Request cancellation of one exact authoring turn

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}$
authoringSessionId
string
required
Pattern: ^authsess_[0-9a-z]{12,32}$
authoringTurnId
string
required
Pattern: ^aturn_[0-9a-z]{12,32}$

Body

application/json
confirm
string
required
Pattern: ^aturn_[0-9a-z]{12,32}$

Response

Request cancellation of one exact authoring turn

schemaVersion
enum<number>
required
Available options:
1
authoringTurnId
string
required
Pattern: ^aturn_[0-9a-z]{12,32}$
authoringSessionId
string
required
Pattern: ^authsess_[0-9a-z]{12,32}$
organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
sequence
integer
required
Required range: 0 < x <= 9007199254740991
prompt
string
required
Required string length: 1 - 32768
model
enum<string>
required
Available options:
opus,
sonnet,
haiku
effort
enum<string>
required
Available options:
low,
medium,
high,
xhigh,
max
maxTurns
integer
required
Required range: 0 < x <= 200
maxBudgetUsd
number
required
Required range: 0 < x <= 1000
timeoutMs
integer
required
Required range: 1000 <= x <= 7200000
state
enum<string>
required
Available options:
queued,
running,
succeeded,
unchanged,
failed,
cancelled
operationId
string
required
Pattern: ^op_[0-9a-z]{12,32}$
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
proposalId
string
Pattern: ^aprop_[0-9a-z]{12,32}$
agentSessionId
string
Required string length: 1 - 255
actualModel
string
Required string length: 1 - 255
turnsUsed
integer
Required range: 0 <= x <= 200
durationMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991
estimatedCostUsd
number
Required range: 0 <= x <= 999999.999999
resultText
string
Maximum string length: 100000
error
object
cancelRequestedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991
startedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991
finishedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991