Skip to content

List prompt templates

GET/ai/copilot/templates

Returns all saved prompt templates for the tenant. Templates encapsulate reusable prompt structures with variable placeholders and are referenced by template_id when executing copilot queries.

Request

Query parameters

NameTypeRequiredDescription
categorystringNo

Filter templates by category label (e.g. "sales", "support", "hr").

pageintegerNo

Default: 1

Responses

200 Paginated list of prompt templates

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · AiPromptTemplateV1No
data[].idintegerNo

Auto-incremented primary key.

data[].namestringNo

Human-readable template name.

data[].categorystring, nullableNo

Category label for grouping (e.g. "sales", "support", "hr").

data[].prompt_bodystringNo

The template prompt body with {{variable_name}} placeholders.

data[].variablesarray of stringNo

List of variable names expected by this template.

data[].is_activebooleanNo

Whether the template is available for use in copilot queries.

data[].notesstring, nullableNo
data[].created_atstring (date-time)No
data[].updated_atstring (date-time)No
metaobject · PaginationMetaNo
meta.current_pageintegerNo
meta.per_pageintegerNo
meta.totalintegerNo

Example

{
  "data": [
    {
      "id": 12,
      "name": "Ticket Summary",
      "category": "support",
      "prompt_body": "Summarise the last {{n}} support tickets for {{customer_name}} and identify the most common issue.",
      "variables": [
        "n",
        "customer_name"
      ],
      "is_active": true,
      "created_at": "2026-02-10T08:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 28
  }
}

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/ai/copilot/templates" \
  -H "Accept: application/json"
Loading