tasks

Cancel a task

post/v1/tasks/{task_id}/cancel

Request

  • Base URL: https://api.beatra.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.beatra.ai/v1/tasks/{task_id}/cancel
  • Auth: none declared

Path parameters

task_idstring required

Headers

authorizationstring nullable

Request body

reasonstring nullable

Response

Already terminal; returns final state (idempotent)

object'task'
task_idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
capabilitystring required
workload_type'model' | 'social_operation'
modelstring nullable

Caller-requested model verbatim (may be 'auto'). Null for social_operation tasks.

resolved_modelstring nullable

Actual model that ran (null until execution starts; equals model for explicit-model calls)

model_selection_reasonunknown
metadataobject nullable
inputobject nullable
outputobject nullable
created_atstring date-time required
started_atstring date-time nullable
deadline_atstring date-time nullable
completed_atstring date-time nullable
cancel_requested_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.