Skip to main content

​
Introduction

The Run API is simplest way to consume your project APIs. You trigger a single API from your project, and then retrieve the results directly.

​
Asynchronous API

The asynchronous API (Async API) allows you to start the API call and receive a runId which you can use to check the status of the run and get the result. In more detail, consuming the Async API involves the following steps:
  1. Start the API run: Start the API run by calling start with the API name, parameters and any other configurations.
  2. Get the runId: The start response will include a runId, it will be used to get the result. For example:
{
  "runId": "abcdegf"
}
  1. Check the result: Use the runId to check the result of the run by calling result.
  • The response will include a status field to indicate the status of the run. pending means the run is still in progress, completed or failed means the run finished, with success and failure respectively.
The runId can also be used to monitor your runs in the Runs tab of your project.

​
API reference