Skip to navigation
API ReferenceTasks

Cancel a task

Beta
View as Markdown
Cancel the Task and revoke its delegated credential. Its Conversation remains busy until native cleanup is acknowledged.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

taskIdstringRequired
Unique task identifier generated by BCTRL.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
agentIdstring
Unique agent identifier generated by BCTRL.
artifactslist of objects
conversationIdstring
Unique conversation identifier generated by BCTRL.
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
errorCodestring or null
errorMessagestring or null
finishedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
idstring
Unique task identifier generated by BCTRL.
inputany

Any valid JSON value: object, array, string, number, boolean, or null.

inputRequestobject or null
metadataobject or null
object"task"
outputany or null

Any valid JSON value: object, array, string, number, boolean, or null.

outputSchemaobject or null
runslist of strings
spaceIdstring
Unique space identifier generated by BCTRL.
startedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
statusenum
traceIdstring or null

W3C trace ID: GET /traces/{traceId} returns the span tree.

updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
usageobject
versioninteger
versionIdstring
Unique agentVersion identifier generated by BCTRL.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error