Create new executions
POST
/v1/executions
Creates new executions based on provided request.
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.
Body parameters
Expand All
object
workflowId string Required
Unique identifier of the workflow associated with the execution
sources Array of object (v1CreateExecutionsRequestSource) Required
List of sources limited to 100 sources
object
document object (v1Document)
documentBlob object (v1DocumentBlob)
mimeType string Required
content string (byte)
Document bytes
Document bytes must be non-empty.
name string
Document Display Name supports all Unicode
The display name of the document supports all Unicode
*
?
[
]
%
{
} , '
\"
characters except the following:
,
,
,
,
,
,
, ,
and are reserved.
and are reserved. If not specified, Execution ID will be
, =
:
used as name.
Responses
Success. All executions were created successfully. The response contains execution IDs for all documents in the request. This indicates that all documents were accepted for processing.
Expand All
object
results Array of object (v1ExecutionResult)
The results of the execution for each source, maintaining the order of input sources.
object
executionId string
The unique identifier of the execution.
errorMessage string
The error message if the execution failed.
200
Multi-Status. Partial success where some executions were created while others failed. The response contains a mix of execution IDs for successful documents and error messages for failed ones. Common partial failure scenarios include: invalid document formats, virus scan failures, wrong file formats, etc. Executions that were successfully created have already been accepted for processing and require no further action. For the failed executions, please refer to the provided error messages for details and retry as necessary.
207
Bad Request. The request failed validation or processing. This can occur due to issues like invalid workflow ID, total file size exceeding limits, malformed request format, or when all documents fail validation (e.g., invalid formats). The response will include detailed error messages to help identify and resolve the specific issues.
400
Unauthorized. Please check if your API key and organization id are correct.
401
EXAMPLE | { "code": 0, "message": "string" } | ||
|---|---|---|---|
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