List retained runs for this Workflow, newest first. Each run corresponds to one matching Asset event.
GET
/workflows/{workflowId}/runs
Authorization
Authorization
header
string
required
Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"
Query Parameters
limit
default: 100
integer
Limit specifies the maximum number of results to return.
Accepts 1 to 100. Defaults to 100.
Required range: 1 <= x <= 100
offset
default: 0
integer
Offset specifies the number of matching results to skip.
Must be at least 0. Defaults to 0.
Required range: x >= 0
latest_per_asset
default: false
boolean
LatestPerAsset specifies whether to return only the latest matching run for each Asset. Defaults to false. Pagination and total count apply to Assets when true.
asset_id
string
AssetId specifies the Asset whose results to return. Omit it to include all Assets.
status
string
Status specifies the run status to filter by. Omit it to include all statuses.
Available options:
pendingrunningcompletedfailedcancelled
created.gte
integer
Created at or after this Unix timestamp in seconds.
created.lte
integer
Created at or before this Unix timestamp in seconds.
event_id
string
EventId specifies the triggering event ID to filter by. Omit it to include all events.
Path Parameters
workflowId
string
required
ID of the Workflow.
Responses
application/json
data
object[]
required
Workflow runs in this page.
actions
object
required
Counts of action outcomes in this run. Reused actions are included in completed.
cancelled
integer
required
Number of actions cancelled before completion.
Required range: x >= 0
completed
integer
required
Number of actions that completed successfully, including reused outputs.
Required range: x >= 0
failed
integer
required
Number of actions that failed.
Required range: x >= 0
reused
integer
required
Number of completed actions that reused an existing output. Included in completed.
Required range: x >= 0
skipped
integer
required
Number of actions skipped without producing an output.
Required range: x >= 0
total
integer
required
Total number of actions in the run, including unfinished actions.
Required range: x >= 0
asset_execution_status
string
required
Current run status. pending means its actions have not started; running means work remains. After all actions finish, failed takes precedence over cancelled. Otherwise the run is completed, including when actions were skipped.
Available options:
pendingrunningcompletedfailedcancelled
asset_id
string
required
ID of the Asset processed by this run.
completed_at
object
date-time
required
When the run completed, failed, or was cancelled. Null while the run is pending or running.
created_at
string
date-time
required
When the run was created.
event
string
required
Event specifies the Asset lifecycle event that triggered this run, or manual when the Asset was updated to a newer revision. Action details are available from the run's actions endpoint.
event_id
object
required
EventId specifies the event that triggered this run. Null when the Asset was updated to a newer revision.
id
string
required
Unique Workflow run ID.
revision
integer
required
Pinned Workflow revision used by this run.
root_run_id
string
required
ID of the first run in this event chain. Equals id when this run starts the chain.
status
string
required
Current run status. pending means its actions have not started; running means work remains. After all actions finish, failed takes precedence over cancelled. Otherwise the run is completed, including when actions were skipped.
Available options:
pendingrunningcompletedfailedcancelled
updated_at
string
date-time
required
When the run was last updated.
workflow_id
string
required
ID of the Workflow executed by this run.
error
string
Reason the run failed. Omitted when no failure message is available.
limit
integer
required
Maximum number of results requested per page.
offset
integer
required
Number of matching results skipped.
status
"success"
string
required
Status of the API request. Always success for this response.
total
integer
required
Total number of results matching the filters before pagination.
List Workflow runs
application/json
error
object
required
code
400
integer
required
Code is the HTTP status code
Examples:
400
message
string
required
Message is a human-readable error description
Examples:
Invalid request parameters
type
"ValidationError"
string
required
Type indicates the error category
Available options:
ValidationError
status
"error"
string
required
Status indicates the response status "error"
Validation error
application/json
error
object
required
Error response details
code
401
integer
required
Code is the HTTP status code
Examples:
401
message
string
required
Message is a human-readable error description
Examples:
Authentication error: invalid token or subscription inactive
type
"AuthenticationError"
string
required
Type indicates the error category
Available options:
AuthenticationError
status
"error"
string
required
Status indicates the response status "error"
Authentication error
application/json
error
object
required
Error response details
code
403
integer
required
Code is the HTTP status code
Examples:
403
message
string
required
Message is a human-readable error description
Examples:
Unauthorized to perform this action
type
"ForbiddenError"
string
required
Type indicates the error category
Available options:
ForbiddenError
status
"error"
string
required
Status indicates the response status "error"
Forbidden error
application/json
error
object
required
Error response details
code
404
integer
required
Code is the HTTP status code
Examples:
404
message
string
required
Message is a human-readable error description
Examples:
Ressource not found
type
"NotFoundError"
string
required
Type indicates the error category
Available options:
NotFoundError
status
"error"
string
required
Status indicates the response status "error"
NotFound error
application/json
error
object
required
Error response details
code
409
integer
required
Code is the HTTP status code
Examples:
409
message
string
required
Message is a human-readable error description
Examples:
source_unavailable: the original video is no longer accessible
type
"ConflictError"
string
required
Type indicates the error category
Available options:
ConflictError
status
"error"
string
required
Status indicates the response status "error"
Conflict error
application/json
error
object
required
Error response details
code
429
integer
required
Code is the HTTP status code
Examples:
429
message
string
required
Message is a human-readable error description
Examples:
Rate limit exceeded
type
"TooManyRequestsError"
string
required
Type indicates the error category
Available options:
TooManyRequestsError
status
"error"
string
required
Status indicates the response status "error"
TooManyRequests error
application/json
error
object
required
Error response details
code
503
integer
required
Code is the HTTP status code
Examples:
503
message
string
required
Message is a human-readable error description
Examples:
The service is temporarily unavailable; retry the request