workflow-runs

Get a workflow run.

Changed on

Returns all public details for a WorkflowRun owned by the addressed agent-workflow pair.

get/api/workflow/{agentName}/{workflowName}/run/{runName}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflow/{agentName}/{workflowName}/run/{runName}
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

workflowNamestring required

Workflow name scoped to an agent.

runNamestring required

WorkflowRun resource name.

Response

Workflow run details.

namestring required

WorkflowRun resource name.

agent_namestring required
workflow_namestring required

Workflow name scoped to an agent.

trigger_type'Schedule' | 'Webhook' required
schedule_namestring

WorkflowSchedule resource name.

timeout_secondsinteger required
status'Pending' | 'Running' | 'Succeeded' | 'Failed' | 'Unacked' required
reasonstring required
messagestring required
session_idstring
created_atstring date-time required
started_atstring date-time
completed_atstring date-time
duration_secondsinteger

Changes

  • d197d7b57b8dRevision changes
    • info

      added the non-success response with the status

  • c3bba62f11e5Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status