Executes orchestrator by {uuid}

Asynchronous

Details

Path → https://api.discuro.com/v1/orchestrators/execute Method → POST

How it works

1. Invoke an Orchestrator

2. Receive ID of execution in body, following successful execution

3. Periodically make requests to our Retrieve Execution API to check the status, and pull your data once “status” has been updated to “ended”

Read more here

Request Body Example

{
    "orchestrator_uuid": "<UUID>",
    "inputs": [
        {
            "name": "<input name>",
            "value": "<input value>"
        },
        {
            "name": "<input name>",
            "value": "<input value>"
        }
    ],
    "tags": [
        {
            "key": "<key>",
            "value": "<value>"
        }
    ]
}

Response Examples

Success - Status Code 200

1 → Upon successful execution, we’ll send back an ID in the request body.

2 → Your application will have to save this ID.

3 → And make periodic calls to the Retrieve Execution API in order to get the status of this execution.

Learn more about this here

{
    "id": 142
}

Instant Failure - Status Code 400

1 → Upon failure, we’ll send back an error message in the request body.

2 → This API is asynchronous, so your execution can still fail after

{
    "error": "Error: missing input values (industry, number_of_topics, )",
    "meta_data": null
}

WARNING: You may also experience an error at execution run, rather than on execution. Please make sure your app handles both use cases:

• Instant failure from this API

• Failure from Retrieve Execution API
• We recommend you read more about failed executions on the “Retrieve Execution” API documentation page.