Create an agent thread

import requests
url = "https://api.middesk.com/v1/threads"
payload = { "type": "cip_orchestrator" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "object": "thread",
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "status": "pending",
  "metadata": {
    "key": "value"
  },
  "requester": {
    "key": "value"
  },
  "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 thread for running agent workflows

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 thread

business_idstringOptionalformat: "uuid"

Optional business ID to associate with the agent thread

Response

agent thread created with business context

objectstring

Object type identifier.

idstringformat: "uuid"

Unique identifier for the agent thread.

created_atdatetime

Timestamp when the agent thread was created.

updated_atdatetime

Timestamp when the agent thread was last updated.

statusenum

Current lifecycle status of the agent thread.

Allowed values:

metadatamap from strings to any or null

Internal metadata associated with the agent thread.

requestermap from strings to any or null

Requester context associated with the agent thread.

stepslist of objects or null

Execution steps emitted by the underlying agent state

Authentication

Request

Response

Errors