Skip to content
Qualia Docs

Estimate Pipeline Run

POST
/v1/runs/estimate
 
curl --request POST \
  --url https://junction-api.qualiastudios.dev/v1/runs/estimate \
  --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 }'

The most a run of a template billed per run may cost: what submit would reserve, by the same computation, with its quote. It starts and reserves nothing; dataset fields are prepared as submit prepares them.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
RunEstimateRequest
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
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
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
RunEstimateResponse

The most a run may cost, reserved in full at submit; usage is charged and the rest refunded when it ends. Never the final charge.

object
credits
required
integer
max_cost
integer | null
sample_cap
integer | null
fits
required
boolean
pricing_revision
required
string
quote_digest
required
string
nodes
object
key
additional properties
integer
Example generated
{
  "credits": 1,
  "max_cost": 1,
  "sample_cap": 1,
  "fits": true,
  "pricing_revision": "example",
  "quote_digest": "example",
  "nodes": {
    "additionalProperty": 1
  }
}

401

Section titled “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"
}

403

Section titled “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"
}

422

Section titled “422 ”

Not billed per run, or the run cannot be bounded