Retrieve an agent run

import requests
url = "https://api.middesk.com/v1/runs/id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

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

Retrieves details of a specific agent run

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Agent run ID

Response

agent run found

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

404

Get Agent Run Request Not Found Error