Launch Pipeline Run

POST

/v1/runs

curl --request POST \
  --url https://example.com/v1/runs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "pipeline_template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "values": {}, "name": "example" }'

Launch any launchable template with flat values for its exposed ports.

Authorizations

• ApiKey
• Bearer

Request Body ^required

Media type application/json

RunSubmitRequest

object

pipeline_template_id

required

string format: uuid

project_id

required

string format: uuid

values

object

key

additional properties

any

name

string | null

<= 255 characters

Example ^generated

{
  "pipeline_template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "values": {},
  "name": "example"
}

Responses

200

Successful Response

Media type application/json

RunSubmitResponse

object

job_id

required

string

status

required

string

message

required

string

Example ^generated

{
  "job_id": "example",
  "status": "example",
  "message": "example"
}

400

Values violate the template contract

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation error