Skip to main content
POST
Python

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

run_id
string
required

Query Parameters

principal_id
string

Scope by principal. If omitted, only a run with no principal (principal_id is null) is addressed; a run whose principal differs yields 404.

Response

Cancellation accepted. Active runs are returned in CANCELLING state.

run_id
string
required
thread_id
string
required
workflow_type
string
required
provider
enum<string>
required
Available options:
ANTHROPIC_DIRECT,
BEDROCK,
OPENAI,
VERTEX_AI
execution_mode
enum<string>
required
Available options:
LOCAL,
AGENTCORE
status
enum<string>
required

Agent run lifecycle state.

Available options:
QUEUED,
RUNNING,
CANCELLING,
SUCCEEDED,
FAILED,
CANCELLED
input_history_mode
enum<string>
required

How the request supplied conversation history for this run.

Available options:
legacy_full,
delta_v1
context_start_run_id
string | null
required

Oldest run included in the reconstructed rolling context, or null when none was needed.

context_truncated
boolean
required

Whether older turns were omitted to stay within the server context budget.

runtime_arn
string | null
mcp_session_id
string | null
trace_id
string | null

保存済みW3C trace contextから導出したlowercase OpenTelemetry trace ID。移行前の行はnull。

Pattern: ^[0-9a-f]{32}$
Example:

"4bf92f3577b34da6a3ce929d0e0e4736"

request_id
string | null

Correlation ID of the first request that created this run. For HTTP creation it matches that request's X-Request-ID. Idempotent retries and later reads preserve this value even though their own HTTP response headers carry different request IDs. Runs created before correlation recording was introduced return null. Direct service callers without an HTTP request receive a generated correlation ID.

idempotency_key
string | null
created_at
string<date-time> | null
started_at
string<date-time> | null
finished_at
string<date-time> | null
input
object | null

Server-enriched agent input used to reconstruct the thread transcript.

parent_run_id
string | null

Run this run branched from within the thread (null for the thread root).

result
object | null
error
object | null