Middesk APIAgentsRuns

Create an agent run

Creates a new agent run

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
typestringRequired
The agent type to use for this agent run
business_idstringOptionalformat: "uuid"

Business to use as context for the run. Shorthand for context_type=business. Required when thread_id is not provided (unless context_type and context_id are given).

context_typestringOptional

The type of context resource (e.g., “business”)

context_idstringOptionalformat: "uuid"

The ID of the context resource. Must be provided with context_type.

thread_idstringOptionalformat: "uuid"
Optional agent thread ID in which to execute the agent run

Response

agent run created within existing agent thread
objectstring
Object type identifier.
idstringformat: "uuid"
Unique identifier for the agent run.
created_atdatetime
Timestamp when the agent run record was created.
updated_atdatetime
Timestamp when the agent run record was last updated.
statusenum
Current lifecycle status of the agent run.
Allowed values:
started_atdatetime or null
Timestamp when the agent run started.
ended_atdatetime or null
Timestamp when the agent run finished.
stepslist of objects or null

Top-level execution steps for this run, filtered by run_id. Only included when requesting run details with step state.

Errors