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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T10:00:00Z",
  "status": "completed",
  "started_at": "2024-01-15T09:30:00Z",
  "ended_at": "2024-01-15T09:59:59Z",
  "steps": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "activity",
      "name": "fetch_business_data",
      "label": "Fetch Business Data",
      "status": "completed",
      "started_at": "2024-01-15T09:30:00Z",
      "graph": "verification-workflow-v2",
      "parent_step_id": null,
      "completed_at": "2024-01-15T09:35:00Z",
      "result": {
        "records_fetched": 120,
        "source": "business_registry"
      },
      "artifacts": [
        {
          "title": "Business Registry Snapshot",
          "type": "json",
          "confidence": "high",
          "summary": "Snapshot of business registry data used for verification",
          "sources": [
            {
              "url": "https://businessregistry.example.com/api/v1/records/12345",
              "source_name": "Business Registry API",
              "source_tier": "trusted",
              "source_type": "api"
            }
          ],
          "data": {
            "business_name": "Acme Corporation",
            "registration_number": "123456789",
            "status": "active"
          }
        }
      ]
    }
  ]
}

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 or null

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

Authentication

Path parameters

Response

Errors