Get Template

GET

/api/v1/templates/:template_id

GET

/api/v1/templates/:template_id

curl https://api.onepin.ai/api/v1/templates/template_id \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "string",
    "name": "string",
    "definition": {
      "graph": {
        "nodes": [
          {
            "id": "string",
            "type": "source_script",
            "position": {
              "x": 1.1,
              "y": 1.1
            },
            "name": "string",
            "config": {},
            "config_version": 1
          }
        ],
        "edges": [
          {
            "id": "string",
            "source": "string",
            "sourcePort": "string",
            "target": "string",
            "targetPort": "string"
          }
        ]
      },
      "execution": {
        "steps": [
          "string"
        ],
        "params": {}
      }
    },
    "is_starter": true,
    "is_public": true,
    "uses_count": 1,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "description": "string",
    "category": "media",
    "is_favorite": false,
    "created_by": "string"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}

Fetch a single template by ID.

Returns the template if it is visible to the caller: templates owned by the caller’s workspace are returned with the live draft definition; public/starter templates from other workspaces are returned with the published snapshot.

Returns 404 for templates that exist but are not visible to the caller (not owned, not public, not a starter) — same response as for a missing ID.

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

Response shape. workspace_id is intentionally omitted so the gallery endpoint (which returns rows from any workspace) does not leak tenant ownership IDs across tenants. created_by is retained as author provenance for public/starter rows.

definition is the serialized WorkflowDefinition JSONB (same shape as Workflow.definition) — a template is a reusable workflow snapshot.

metaobject

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Response

Errors