Estimate Template

{
  "data": {
    "unit_chars": 1000,
    "variable_min_credits_per_unit": 5,
    "variable_expected_credits_per_unit": 8,
    "variable_max_credits_per_unit": 12,
    "fixed_min_credits": 3,
    "fixed_expected_credits": 5,
    "fixed_max_credits": 7,
    "total_min_credits_per_unit": 8,
    "total_expected_credits_per_unit": 13,
    "total_max_credits_per_unit": 19,
    "breakdown": [
      {
        "node_id": "n1a2b3c4",
        "node_type": "text_synthesis",
        "min_credits": 4,
        "expected_credits": 6,
        "max_credits": 9
      },
      {
        "node_id": "n5d6e7f8",
        "node_type": "data_fetch",
        "min_credits": 1,
        "expected_credits": 2,
        "max_credits": 3
      },
      {
        "node_id": "n9g0h1i2",
        "node_type": "post_processing",
        "min_credits": 3,
        "expected_credits": 5,
        "max_credits": 7
      }
    ],
    "source_snapshot": "draft",
    "source_node_ids": [
      "n1a2b3c4",
      "n5d6e7f8",
      "n9g0h1i2"
    ],
    "definition_fingerprint": "a3f5c9d7e1b2f4a6",
    "rate_fingerprint": "b7d8e9f0a1c2d3e4",
    "cache_status": "hit",
    "computed_at": "2024-01-15T09:30:00Z"
  },
  "meta": {
    "request_id": "req_20240115_093000_abc123",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}

Estimate the credit cost of running a workflow built from this template.

Returns a per-unit pricing guide expressed in credits per unit_chars input characters (default 1,000). Because the template does not contain the caller’s actual script, the estimate uses a synthetic fixed-length input to compute a reproducible per-unit rate. Multiply by your expected character count to project total cost.

The response distinguishes variable costs (scale with script length, e.g. synthesis) from fixed costs (apply once per run regardless of length). A node-level breakdown is included so callers can see which processing steps drive the cost.

Results are cached against the template definition and current pricing rates. cache_status indicates whether this response was served from cache (hit), computed fresh (miss), or recomputed because the definition or rates changed (stale).

Visibility rules match GET /templates/{id} — own-workspace templates use the draft definition; cross-workspace templates use the published snapshot.

Dual-auth: Bearer JWT or API key (scope templates:read).

Authentication

AuthorizationBearer

Clerk JWT token

AuthorizationBearer

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

Path parameters

template_idstringRequiredformat: "^[A-Za-z0-9]{8}$"=8 characters

Case-sensitive 8-character base62 template identifier.

Response

Successful Response

dataobject

Per-unit pricing guide for a visible template snapshot.

Templates do not contain the caller's final script. Costs are therefore quoted for a fixed input-character unit plus fixed workflow overhead; cloned workflows still use EstimateResponse once real script text exists.

metaobject

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors