Retrieve an agent thread

curl https://api.middesk.com/v1/threads/id \
     -H "Authorization: Bearer <token>"

{
  "object": "thread",
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "status": "running",
  "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",
      "agent": "agent",
      "parent_step_id": "parent_step_id",
      "completed_at": "2024-01-15T09:30:00Z",
      "artifacts": [
        {
          "title": "title",
          "type": "type"
        }
      ]
    }
  ]
}

Retrieves details of a specific agent thread

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Agent thread ID

Response

agent thread found

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

Execution steps emitted by the underlying agent state

Errors

404

Get Agent Thread Request Not Found Error

$	curl https://api.middesk.com/v1/threads/id \
>	-H "Authorization: Bearer <token>"

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