Lists executions by page
GET
/v1/executions
Executions based on provided request parameters
Lists all executions based on the provided request parameters.
Security
API Key
Header parameter name
The API key to use for authentication.
orby-api-key
Header parameters
orby-org-id string Required
The organization id to handle execution requests for.
Query parameters
pageSize integer (int32)
The number of executions to return per page. Minimum is 1, maximum is 100, default is 10.
pageToken string
The token for fetching the next page of executions.
filter.workflowIds array of string
A list of workflow ids to filter the executions by. A single value example: filter.workflowIds=some_id. A multiple values example: filter.workflowIds=some_id1&filter.workflowIds=some_id2
filter.statuses array of string
The status of the executions to filter by. Possible values are: 'SCHEDULED', 'BLOCKED', 'EXECUTING', 'PENDING_REVIEW', 'COMPLETED', 'FAILED',
'CANCELLED'. A single value example: filter.statuses=COMPLETED. A multiple values example: filter.statuses=COMPLETED&filter.statuses=PENDING_REVIEW
filter.query string
Filter string query for custom labels. Supported examples: 'NOT customLabels:*' (has no labels), 'customLabels:value' (has specific label), 'NOT customLabels:value' (doesn't have specific label), 'customLabels:value1,value2' (has multiple labels).
Responses
200
A successful response.
Expand All
object
executions Array of object (v1Execution)
Executions returned in the response.
object
id string
Unique identifier of the execution.
name string
Name of the execution.
workflowId string
Unique identifier of the workflow
Unique identifier of the workflow associated with the execution.
workflowName string
Name of the workflow
Name of the workflow associated with the execution.
status string
Output only.
VALID VALUES | [ "\"STATUS_UNSPECIFIED\"", "\"SCHEDULED\"", "\"BLOCKED\"", "\"EXECUTING\"", "\"PENDING_REVIEW\"", "\"COMPLETED\"", "\"FAILED\"", "\"CANCELLED\"" ] | |
|---|---|---|
DEFAULT | "STATUS_UNSPECIFIED" |
error object (v1ExecutionError)
type string
Type of the error, e.g. 'LOW_DOCUMENT_CLASSIFICATION_SCORE', 'LARGE_DOCUMENT_SIZE', 'FAILED_AFTER_ACCEPTED', 'UNMATCHED_CLASSIFICATION', 'FAILED_EXECUTION_ENGINE', 'INVALID_DOCUMENT_MIME_TYPE', 'NO_AVAILABLE_USERS', 'MAX_WORKFLOW_LIMIT_REACHED', 'FAILED_TO_CREATE_TASK', 'FILE_DECRYPTION_FAILED', 'WRONG_FILE_FORMAT', 'USER_CANCELLED_EXECUTION'.
details string
Details of the error.
sourceExecutionId string
The unique identifier of the source execution that triggers the current execution.
followingUpExecutionIds Array of string
The unique identifiers of the following up executions from the current execution.
string
warnings Array of object (v1ExecutionWarning)
The warnings generated during the execution of few shot workflow
object
type string
Type of the warning, e.g. 'WARNING_LLM_OUTPUT_TOKEN_LIMIT_EXCEEDED'.
details string
The detailed description of the warning.
customLabels Array of string
Custom labels for the execution. Max 255 characters per label. Label can only contain alphanumeric characters, underscores, and hyphens.
string
nextPageToken string
The token to retrieve the next page of results.
Bad Request. The request is invalid. Please check the request body and try again.
400
{ "code": 0, "message": "string" }
EXAMPLE
Unauthorized. Please check if your API key and organization id are correct.
401
{ "code": 0, "message": "string" }
EXAMPLE
Not Found. The resource you are trying to access does not exist.
404
{ "code": 0, "message": "string" }
EXAMPLE
Rate Limit Exceeded. Please try again later.
429
Internal Server Error. Please try again later or contact Orby support if the issue persists.
500
{ "code": 0, "message": "string" }
EXAMPLE