Preview Run | Onepin

{
  "data": {
    "min_credits": 15,
    "expected_credits": 20,
    "max_credits": 25,
    "breakdown": [
      {
        "node_id": "node-7f3a2c9b",
        "node_type": "data_ingestion",
        "min_credits": 5,
        "expected_credits": 7,
        "max_credits": 10
      },
      {
        "node_id": "node-4d1e8f2a",
        "node_type": "model_inference",
        "min_credits": 8,
        "expected_credits": 10,
        "max_credits": 12
      },
      {
        "node_id": "node-9b6c3d1f",
        "node_type": "post_processing",
        "min_credits": 2,
        "expected_credits": 3,
        "max_credits": 3
      }
    ],
    "current_balance": 100,
    "deficit_at_max": 0,
    "can_run": true
  },
  "meta": {
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "timestamp": "2024-04-27T14:45:00Z"
  }
}

Dry-run credit estimate for a workflow — no run is created.

Returns a per-node-type credit breakdown based on the workflow’s current definition. No run is enqueued, no credits are charged, and the workflow state is not modified. Use this before calling POST /runs to confirm the expected cost. Equivalent to POST /estimate.

Authentication

AuthorizationBearer

Clerk JWT token

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

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

$	curl -X POST https://api.onepin.ai/api/v1/workflows/workflow_id/runs/preview \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'