POST
/
{workspaceId}
/
projects
/
{projectName}
/
run
/
start
Run API - Async Start
curl --request POST \
  --url https://app.intuned.io/api/v1/workspace/{workspaceId}/projects/{projectName}/run/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "api": "my-awesome-api",
  "parameters": {
    "param1": "value1",
    "param2": 42,
    "param3": true
  },
  "retry": {
    "maximumAttempts": 3
  }
}'
{
  "runId": "<string>",
  "status": "pending"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
workspaceId
string<uuid>
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 input schema

​
parameters
object
required

The parameters to be passed to the API.

Example:
{
  "param1": "value1",
  "param2": 42,
  "param3": true
}
​
api
string
required

The name of the API to be executed. This is the file path relative to the api folder inside your project.

​
proxy
string<uri>

Proxy URL to be used for the API call. This is optional and can be used to route the API call through a proxy server.

Example:

"http://username:password@domain:port"

​
saveTrace
boolean
default:true
​
requestTimeout
integer
default:600

Timeout for the API request in seconds. Default is 10 minutes (600 seconds).

Example:

600

​
retry
object

Retry policy configurations in case of failure.

Example:
{ "maximumAttempts": 3 }
​
authSession
object

Auth session config to be used with the run. This is a required field if the auth session is enabled on the project. Credentials based auth session config to be used with the run. This is a required field if the auth session is enabled on the project and uses credentials.

​
sink
object

Optional sink configuration for the run. Can be a webhook or S3 sink. Configuration for the webhook sink.

Response

200 - application/json

Object with user data.

​
runId
string
required

Unique identifier for the run, nanoId of 21 characters

​
status
enum<string>
required
Available options:
pending