Launch Pipeline Run

POST

/v1/runs

curl --request POST \
  --url https://junction-api.qualiastudios.dev/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", "max_cost": 1, "sample_cap": 1, "idempotency_key": "example", "quote_digest": "example" }'

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

A template billed per run reserves its whole bound before it starts and needs max_cost; POST /v1/runs/estimate gives the bound first.

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

max_cost

integer | null

>= 1

sample_cap

integer | null

>= 1

idempotency_key

string | null

>= 1 characters <= 200 characters

quote_digest

string | null

/^[0-9a-f]{64}$/

Example ^generated

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

Responses

200

Successful Response

Media type application/json

RunSubmitResponse

object

job_id

required

string

status

required

string

message

required

string

audience

string

nullable

Allowed values: internal public

Example

{
  "audience": "internal"
}

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"
}

402

The account cannot cover the run’s bound

403

Missing capability on the workspace

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

409

Stale quote, or an idempotency key reused

422

Validation error, or the run’s bound is over max_cost