Estimate Workflow

{
  "data": {
    "min_credits": 5,
    "expected_credits": 8,
    "max_credits": 12,
    "breakdown": [
      {
        "node_id": "node-7a3f2c1d",
        "node_type": "http_request",
        "min_credits": 2,
        "expected_credits": 3,
        "max_credits": 5
      },
      {
        "node_id": "node-9b8e4d2f",
        "node_type": "data_transform",
        "min_credits": 1,
        "expected_credits": 2,
        "max_credits": 3
      },
      {
        "node_id": "node-4c5d6e7f",
        "node_type": "database_query",
        "min_credits": 2,
        "expected_credits": 3,
        "max_credits": 4
      }
    ],
    "current_balance": 20,
    "deficit_at_max": 0,
    "can_run": true
  },
  "meta": {
    "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}

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. 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

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/estimate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'