workflow-runs

List workflow runs for a workflow.

Changed on

Lists paginated WorkflowRuns for an agent-workflow pair. Optional trigger filters narrow the results to schedule-triggered or webhook-triggered runs.

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

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
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

workflowNamestring required

Workflow name scoped to an agent.

Query parameters

status'Pending' | 'Running' | 'Succeeded' | 'Failed' | 'Unacked'

Optional WorkflowRun phase filter.

trigger_type'Schedule' | 'Webhook'

Optional workflow trigger type filter.

schedule_namestring

WorkflowSchedule resource name.

Optional schedule filter. When set, trigger_type must be Schedule.

webhook_api_key_idstring

Better Auth API key identifier.

Optional webhook API key filter. When set, trigger_type must be Webhook.

limitinteger

Maximum number of items to return.

page_tokenstring

Opaque pagination token from a previous response.

Response

Paginated workflow runs for a workflow.

next_page_tokenstring required

Changes

  • d197d7b57b8dRevision changes
    • info

      added the non-success response with the status

  • d44ac82920cdRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status