Skip to main content
POST
Resume a run

Body

application/json
run_id
string<uuid>
required

Identifier of a run

await_resume
object
required

Payload sent by the client to resume an awaiting run.

mode
enum<string>
required

Mode of the request

Available options:
sync,
async,
stream

Response

Run resumed (streaming or immediate)

agent_name
string
required

A unique identifier for the agent following the RFC 1123 DNS label naming convention.

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Example:

"chat"

run_id
string<uuid>
required

Identifier of a run

status
enum<string>
required

Status of the run

Available options:
created,
in-progress,
awaiting,
cancelling,
cancelled,
completed,
failed
output
object[]
required
created_at
string<date-time>
required
session_id
string<uuid>

Identifier of a session

await_request
object | null

Payload describing what is awaited from the client to continue the run.

error
object | null
finished_at
string<date-time>