List AI Prompt Templates

Endpoint

GET /apiops/settings/ai-prompt-templates/

Authentication

Requires a Personal API Access Token with admin privileges.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Query Parameters

Parameter	Type	Required	Default	Description
projectId	string	No	admin	Scope project id. Omit for the admin/global scope.

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "id": "665f3b2d8c4f5b0013cd91dd",
      "projectId": "admin",
      "name": "support-summary",
      "description": "Summarize a support thread into three bullet points",
      "messages": [
        { "role": "system", "content": "You summarize support conversations." },
        { "role": "user", "content": "Summarize the following thread: {{thread}}" }
      ],
      "parameters": [
        { "name": "thread", "required": true }
      ],
      "enabled": true,
      "builtIn": false
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	Entries visible in the resolved scope
resultCount	integer	Number of entries returned

The entry object's fields are documented on the AI Prompt Templates API overview page.

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/settings/ai-prompt-templates/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Scope: the response is the union of built-in ∪ admin-shared ∪ scope-owned entries
• Admin Only: a project-scoped AI_DEVELOPMENT token is not sufficient on this surface

Related Documentation

• Get AI Prompt Template - Get a single entry by name
• AI Prompt Templates API - Resource overview