Create an agent run

import requests
url = "https://api.middesk.com/v1/runs"
payload = {
    "type": "cip_orchestrator",
    "input": "Analyze the litigation history for this business"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "object": "run",
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "status": "pending",
  "started_at": "2024-01-15T09:30:00Z",
  "ended_at": "2024-01-15T09:30:00Z",
  "steps": [
    {
      "id": "id",
      "run_id": "run_id",
      "type": "activity",
      "name": "name",
      "label": "label",
      "status": "running",
      "started_at": "2024-01-15T09:30:00Z",
      "graph": "graph",
      "parent_step_id": "parent_step_id",
      "completed_at": "2024-01-15T09:30:00Z",
      "result": {
        "key": "value"
      },
      "artifacts": [
        {
          "title": "title",
          "type": "type"
        }
      ]
    }
  ]
}

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

inputstringRequired

The input prompt for the agent run

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.

Authentication

Request

Response

Errors