Get single execution details
GET
/v1/executions/{executionId}
Retrieves the details of an execution.
Retrieves the details of a specific execution by its id.
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.
Path parameters
executionId string Required
The unique identifier of the execution to retrieve.
Responses
A successful response.
Expand All
object
execution object (v1Execution) id string
The unique identifier of the execution.
name string
The name of the execution.
workflowId string
The unique identifier of the workflow associated with the execution.
workflowName string
The name of the workflow associated with the execution.
200
status string
VALID VALUES | [ "STATUS_UNSPECIFIED", "SCHEDULED", "BLOCKED", "EXECUTING", "PENDING_REVIEW", "COMPLETED", "FAILED", "CANCELLED" ] | |
|---|---|---|
DEFAULT | "STATUS_UNSPECIFIED" |
error object (v1ExecutionError)
type string
Type of the error
Retrieves the details of a specific execution by its id.
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
unique identifier of the source execution
The unique identifier of the source execution that triggers the current execution.
followingUpExecutionIds Array of string
Unique identifiers of the following up executions
The unique identifiers of the following up executions from the current execution.
string
warnings Array of object (v1ExecutionWarning)
warnings during the execution of few shot workflow
The warnings generated during the execution of few shot workflow
object
type string
Types of warnings
Type of the warning, e.g., 'WARNING_LLM_OUTPUT_TOKEN_LIMIT_EXCEEDED'.
details string
Detailed warning description
The detailed description of the warning.
customLabels Array of string
Custom labels
Custom labels for the execution. Clients can use these to track post- processing status or add other metadata. These can be updated through UpdateExecution() method.
string
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