Skip to main content
POST
Create a background run

Authorizations

Authorization
string
header
required

Server-side API Key; do not expose it in browser code.

Path Parameters

thread_id
string
required

Body

application/json
assistant_id
string
required

Published agent ID. HTTP uses assistant_id; the SDK accepts assistantId as a method argument.

input
object
required

Chat action payload. Examples show send; retry, resume and follow_up require the appropriate execution state and access.

context
object

Optional runtime context. Use only fields supported by your deployed agent.

Response

Successful response.

run_id
string
required
thread_id
string
required
status
string
required

Execution status. Check the status and metadata.agentRun.error; HTTP success is not task success.

assistant_id
string
created_at
string<date-time>
updated_at
string<date-time>
metadata
object