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

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

interruptslist of maps from strings to any

Pending interrupt requests awaiting input. Empty when the run is not interrupted.

Errors

400

Create Agent Run Request Bad Request Error

404

Create Agent Run Request Not Found Error

1	curl -X POST https://api.middesk.com/v1/runs \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"type": "cip_orchestrator"
6	}'

1	{
2	"object": "run",
3	"id": "id",
4	"created_at": "2024-01-15T09:30:00Z",
5	"updated_at": "2024-01-15T09:30:00Z",
6	"status": "running",
7	"started_at": "2024-01-15T09:30:00Z",
8	"ended_at": "2024-01-15T09:30:00Z",
9	"steps": [
10	{
11	"id": "id",
12	"run_id": "run_id",
13	"type": "activity",
14	"name": "name",
15	"label": "label",
16	"status": "running",
17	"started_at": "2024-01-15T09:30:00Z",
18	"agent": "agent",
19	"parent_step_id": "parent_step_id",
20	"completed_at": "2024-01-15T09:30:00Z",
21	"result": {
22	"key": "value"
23	},
24	"artifacts": [
25	{
26	"title": "title",
27	"type": "type"
28	}
29	]
30	}
31	],
32	"interrupts": [
33	{
34	"key": "value"
35	}
36	]
37	}