MImiddesk
runs

Create an agent run

Changed on

Creates a new agent run

post/v1/runs

Request

Request body

typestring required

The agent type to use for this agent run

business_idstring uuid

Business to use as context for the run. Shorthand for context_type=business. Required when thread_id is not provided (unless context_type and context_id are given).

context_typestring

The type of context resource (e.g., "business")

context_idstring uuid

The ID of the context resource. Must be provided with context_type.

thread_idstring uuid

Optional agent thread ID in which to execute the agent run

Response

agent run created within existing agent thread

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 createAgentRun removed and replaced with runs_createAgentRun