MImiddesk
runs

Retrieve an agent run

Changed on

Retrieves details of a specific agent run

get/v1/runs/{id}

Request

Path parameters

idstring required

Agent run ID

Query parameters

includestring

Comma-separated list of optional sub-resources to include. Pass steps to populate the steps array with this run's execution trace; omitted by default to avoid the cost of fetching step state from the underlying execution backend.

Response

agent run found

objectstring required

Object type identifier.

idstring uuid required

Unique identifier for the agent run.

created_atstring date-time required

Timestamp when the agent run record was created.

updated_atstring date-time required

Timestamp when the agent run record was last updated.

status'running' | 'completed' | 'error' | 'interrupted' required

Current lifecycle status of the agent run.

thread_idstring uuid

Identifier of the agent thread this run belongs to.

business_idstring uuid nullable

Middesk business the run is scoped to. Null when the run was started with an inline business payload whose business did not exist yet.

agentstring

Agent type that produced this run (for example, cip_orchestrator).

started_atstring date-time nullable

Timestamp when the agent run started.

ended_atstring date-time nullable

Timestamp when the agent run finished.

Changes

  • 4c9cd4e834baRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

  • 668373c892ceRevision changes
    • info

      api operation id getAgentRun removed and replaced with runs_getAgentRun