Favorite Template

POST

/api/v1/templates/:template_id/favorite

POST

/api/v1/templates/:template_id/favorite

curl -X POST https://api.onepin.ai/api/v1/templates/template_id/favorite \
     -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"
  }
}

Add a template to the current user’s favorites.

Favorites are per-user, not per-workspace — the same favorite list is visible regardless of which workspace the caller is currently acting in. Any template visible to the caller (own workspace, public, or starter) can be favorited.

Returns 404 when the template does not exist or is not visible to the caller. Calling this endpoint on an already-favorited template is idempotent (returns 200 with the template). Use DELETE /templates/{id}/favorite to remove. Does not require X-Workspace-Id.

Authentication

AuthorizationBearer

Clerk JWT token

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