Skip to main content
GET
/
v1
/
workspaces
/
{workspace_id}
/
workflows
/
{workflow_id}
/
runs
/
{run_id}
Get workflow run
curl --request GET \
  --url https://api.app.layer.ai/api/v1/workspaces/{workspace_id}/workflows/{workflow_id}/runs/{run_id} \
  --header 'Authorization: Bearer <token>'
{
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "poll_interval_seconds": 123,
  "steps": [],
  "estimated_price_creative_units": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "actual_price_creative_units": 123,
  "outputs": [
    {
      "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object_type": "directory",
      "url": "<string>",
      "content_type": "<string>",
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "preview_url": "<string>",
      "width": 123,
      "height": 123,
      "duration_seconds": 123,
      "file_size_bytes": 123
    }
  ],
  "error": "<string>",
  "error_code": "<string>"
}

Authorizations

​
Authorization
string
header
required

Personal Access Token or OAuth2 JWT. Create a PAT at app.layer.ai → Settings → Personal Access Tokens.

Path Parameters

​
workspace_id
string<uuid>
required
​
workflow_id
string<uuid>
required
​
run_id
string<uuid>
required

Response

Successful Response

​
run_id
string<uuid>
required

Unique identifier for this workflow run.

​
status
enum<string>
required

Current status: pending, running, success, failure, or cancelled.

Available options:
pending,
running,
success,
failure,
cancelled
​
poll_interval_seconds
integer | null

Suggested polling interval in seconds. Present while PENDING or RUNNING.

​
steps
GetWorkflowRunStep · object[]

Status of each step composing the workflow run.

​
estimated_price_creative_units
number | null

Estimated Creative Units price. Present when available.

​
completed_at
string<date-time> | null

Completion timestamp. Present only on SUCCESS.

​
actual_price_creative_units
number | null

Actual Creative Units price charged. Present only on SUCCESS.

​
outputs
WorkflowRunAsset · object[] | null

Generated assets. Present only on SUCCESS.

​
error
string | null

Error message. Present only on FAILURE.

​
error_code
string | null

Machine-readable error code. Present only on FAILURE.