POST
/
{workspaceId}
/
projects
/
{projectName}
/
run
/
start

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
authSession
object

Auth session configurations

proxy
string

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

retry
object

Retry policy configurations

Response

201 - application/json

Pending API run

runId
string
required

run id of the execution

status
enum<string>
required

The status of the run

Available options:
pending