Templates

Custom content templates (Workbench)

List custom templates

get

List all custom templates for the team. Requires Business plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

pageintegerOptional

Page number for pagination

site_idstring · uuidOptional

Filter by site ID

Responses

200

A list of custom templates

application/json

get

/v1/templates

HTTPcURLJavaScriptPython

GET /v1/templates HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

A list of custom templates

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "site_id": "123e4567-e89b-12d3-a456-426614174000",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "include_faq": true,
    "include_key_takeaways": true,
    "include_ai_images": true,
    "enable_knowledge": true,
    "enable_perplexity": true,
    "created_at": "2026-02-15T14:26:58.159Z",
    "updated_at": "2026-02-15T14:26:58.159Z"
  }
]

Create a custom template

post

Create a new custom template. Requires Business plan or higher.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

namestringRequired

descriptionstringOptional

site_idstring · uuidOptional

system_promptstringRequired

user_promptstringRequired

ideal_outputstringOptional

enable_knowledgebooleanOptionalDefault: false

enable_serpbooleanOptionalDefault: false

enable_perplexitybooleanOptionalDefault: false

include_faqbooleanOptionalDefault: false

include_key_takeawaysbooleanOptionalDefault: false

include_tocbooleanOptionalDefault: false

Responses

201

Template created

application/json

post

/v1/templates

HTTPcURLJavaScriptPython

POST /v1/templates HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 339

{
  "name": "text",
  "description": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "system_prompt": "text",
  "user_prompt": "text",
  "ideal_output": "text",
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "enable_knowledge": false,
  "enable_serp": false,
  "enable_perplexity": false,
  "include_faq": false,
  "include_key_takeaways": false,
  "include_toc": false
}

201

Template created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "include_faq": true,
  "include_key_takeaways": true,
  "include_ai_images": true,
  "enable_knowledge": true,
  "enable_perplexity": true,
  "created_at": "2026-02-15T14:26:58.159Z",
  "updated_at": "2026-02-15T14:26:58.159Z",
  "system_prompt": "text",
  "user_prompt": "text",
  "ideal_output": "text",
  "knowledge_sources": [
    1
  ],
  "include_toc": true,
  "enable_serp": true,
  "ai_image_style": "text",
  "ai_image_model": "text",
  "ai_image_count_body": 1
}

Get a custom template

get

Get template details including prompts and configuration.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idstring · uuidRequired

Template ID

Responses

200

Template detail

application/json

get

/v1/templates/{id}

HTTPcURLJavaScriptPython

GET /v1/templates/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Template detail

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "include_faq": true,
  "include_key_takeaways": true,
  "include_ai_images": true,
  "enable_knowledge": true,
  "enable_perplexity": true,
  "created_at": "2026-02-15T14:26:58.159Z",
  "updated_at": "2026-02-15T14:26:58.159Z",
  "system_prompt": "text",
  "user_prompt": "text",
  "ideal_output": "text",
  "knowledge_sources": [
    1
  ],
  "include_toc": true,
  "enable_serp": true,
  "ai_image_style": "text",
  "ai_image_model": "text",
  "ai_image_count_body": 1
}

Update a custom template

put

Update an existing custom template. Only provided fields are updated.

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idstring · uuidRequired

Template ID

Body

application/json

namestringOptional

descriptionstringOptional

system_promptstringOptional

user_promptstringOptional

ideal_outputstringOptional

enable_knowledgebooleanOptional

enable_serpbooleanOptional

enable_perplexitybooleanOptional

include_faqbooleanOptional

include_key_takeawaysbooleanOptional

include_tocbooleanOptional

Responses

200

Template updated

application/json

put

/v1/templates/{id}

HTTPcURLJavaScriptPython

PUT /v1/templates/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "name": "text",
  "description": "text",
  "system_prompt": "text",
  "user_prompt": "text",
  "ideal_output": "text",
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "enable_knowledge": true,
  "enable_serp": true,
  "enable_perplexity": true,
  "include_faq": true,
  "include_key_takeaways": true,
  "include_toc": true
}

200

Template updated

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "site_id": "123e4567-e89b-12d3-a456-426614174000",
  "variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "include_faq": true,
  "include_key_takeaways": true,
  "include_ai_images": true,
  "enable_knowledge": true,
  "enable_perplexity": true,
  "created_at": "2026-02-15T14:26:58.159Z",
  "updated_at": "2026-02-15T14:26:58.159Z",
  "system_prompt": "text",
  "user_prompt": "text",
  "ideal_output": "text",
  "knowledge_sources": [
    1
  ],
  "include_toc": true,
  "enable_serp": true,
  "ai_image_style": "text",
  "ai_image_model": "text",
  "ai_image_count_body": 1
}

Delete a custom template

delete

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

idstring · uuidRequired

Template ID

Responses

204

Template deleted

delete

/v1/templates/{id}

HTTPcURLJavaScriptPython

DELETE /v1/templates/{id} HTTP/1.1
Host: api.cuppa.ai
X-API-KEY: YOUR_API_KEY
Accept: */*

204

Template deleted

No content