Skip to navigation
ReferenceAPI Referenceworkflows

Estimate Workflow

Estimate the credit cost of running a workflow without creating a run.

Computes a breakdown of expected credits per node type based on the workflow’s current definition. No run is created, no credits are charged, and no side effects occur. The optional request body accepts the same run-scoped script_text/source_language overrides as POST /runs, so an estimate that will be followed by a run with those overrides prices the text that run will actually speak. Equivalent to POST /runs/preview; prefer that path in new integrations as it is co-located with the run lifecycle.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Request

This endpoint expects a nullable object.
script_textstring or nullOptional>=3 characters

Run this workflow with this script text instead of the text saved in the workflow's source_script node. Applied to the run's definition snapshot only.

source_languagestring or nullOptional

BCP-47 language of script_text (e.g. en-us). Optional; when omitted the saved source_language (or automatic detection) applies.

Response

Successful Response
dataobject

Pre-flight estimate range returned by POST /workflows/{id}/runs/preview.

min_credits ≤ owner balance is the run-start gate (don't refuse runs that might fit). FE displays "min-max credits" or single value if min == max.

metaobject

Errors

422
Unprocessable Entity Error