POST
/
{workspaceId}
/
projects
/
{projectName}
/
run
{
  "status": "completed",
  "runId": "aabbccddeeffggh",
  "statusCode": 200,
  "result": {
    "contracts": [
      {
        "id": "#1",
        "contractor": {
          "name": "John Doe",
          "phone": 1234567890
        }
      },
      {
        "id": "#2",
        "contractor": {
          "name": "Jane Doe",
          "phone": 987654321
        }
      }
    ]
  }
}

Authorizations

​
x-api-key
string
headerrequired

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string
required

Your workspace ID. How to find it?

​
projectName
string
required

Your project name. It is the name you provide when creating a project.

Body

application/json

Run API request

​
api
any
required
​
parameters
any
required
​
retry
object

Retry policy configurations

​
authSession
object

Auth session configurations

​
proxy
string

Proxy URL following this format: http://username:password@domain:port

Response

200 - application/json

Completed API run result

​
status
enum<string>
required

The status of the run

Available options:
completed
​
statusCode
number
required

The HTTP status code of the API run

​
runId
string
required

The run ID

​
result
any

The result of an API call.

OverviewRun API - Async Start