Deployments.ai Docs
Workflows

List workflow step attempts

GET /v1/workflow-executions/{workflowExecutionId}/steps · SDK listWorkflowStepAttempts · CLI deployments workflow-execution steps

GET
/v1/workflow-executions/{workflowExecutionId}/steps

Requires workflows:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

workflowExecutionId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListWorkflowStepAttemptsResponse

application/json
  1. response
items*array<>
nextCursor?|null|null
curl -X GET "https://example.com/v1/workflow-executions/string/steps"
{  "items": [    {      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "approvalId": "string",      "attempt": 0,      "childRunId": "string",      "completedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "deliveryId": "string",      "error": {        "property1": null,        "property2": null      },      "id": "string",      "input": {        "property1": null,        "property2": null      },      "object": "workflow-step-attempt",      "output": {        "property1": null,        "property2": null      },      "startedAt": "2019-08-24T14:15:22Z",      "status": "queued",      "stepId": "string",      "stepType": "agent",      "toolCallId": "string",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "workflowExecutionId": "string"    }  ],  "nextCursor": "string"}