Skip to main content
POST
Stop a run

Authorizations

x-api-key
string
header
required

API key from your organization. Supply the value directly, without a Bearer prefix.

Path Parameters

id
string
required

Opaque resource identifier.

Minimum string length: 1

Response

Successful response.

id
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
creating,
running,
stopped,
completed,
failed
agent
object
required
Example:
task
object
required
Example:
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
error
string | null
required

Failure description when status is failed; otherwise null.