Run APIs
Run API - Async Start
Starts a project API run operation
POST
/
{workspaceId}
/
projects
/
{projectName}
/
run
/
start
Authorizations
x-api-key
string
headerrequiredAPI Key used to authenticate your requests. How to create one.
Path Parameters
workspaceId
string
requiredYour workspace ID. How to find it?
projectName
string
requiredYour project name. It is the name you provide when creating a project.
Body
application/json
Run API request
api
any
requiredparameters
any
requiredauthSession
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
requiredrun id of the execution
status
enum<string>
requiredThe status of the run
Available options:
pending