Skip to main content
POST
/
{workspaceId}
/
projects
/
{projectName}
/
run
/
start
Python (SDK)
from intuned_client import IntunedClient
import os


with IntunedClient(
    workspace_id="123e4567-e89b-12d3-a456-426614174000",
    api_key=os.getenv("INTUNED_API_KEY", ""),
) as ic_client:

    res = ic_client.project.run.start(project_name="my-project", parameters={
        "param1": "value1",
        "param2": 42,
        "param3": True,
    }, api="my-awesome-api", proxy="http://username:password@domain:port", save_trace=True, request_timeout=600, retry={}, auth_session={
        "id": "auth-session-123",
        "auto_recreate": True,
        "check_attempts": 3,
        "create_attempts": 3,
        "proxy": "http://username:password@domain:port",
        "request_timeout": 600,
    }, sink={
        "type": "webhook",
        "url": "https://example.com/webhook",
        "headers": {
            "Content-Type": "application/json",
            "Authorization": "Bearer token",
        },
        "skip_on_fail": False,
        "apis_to_send": [
            "api1",
            "api2",
        ],
    })

    # Handle response
    print(res)
{
  "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> | null

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. Runtime 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 runtime input.

  • Runtime Based Auth Session Input
  • Credentials Based Auth Session Input
​
sink
object

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

  • Webhook Sink Configuration
  • S3 Sink Configuration

Response

201 - application/json

Run started successfully.

​
runId
string
required

Unique identifier for the run, nanoId of 21 characters

​
status
enum<string>
required
Available options:
pending