Skip to main content
GET
List agent templates
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/agents/listTemplates returns the platform-wide agent templates the Console’s template gallery shows: each template’s name, description, category, tags, usageCount, its persona notes (soulMd) and definition, what an agent created from it starts with (purpose, execution model, skills, required and optional tools, model, prompt, memory, run limits, governance tier and identity).

Authority

You need agents:read at the platform scope, the key and home of the Console’s gallery: templates are platform-wide and have no home org unit. A grant only at an org unit is a recorded 403.

Filtering

  • search: templates whose name matches these words, best match first. With category too, only matches in that category.
  • category: only that category, oldest first.
  • Neither: the whole gallery, oldest first.
The templates come a page at a time: limit is 1 to 100 (default 50), and a larger value is 400 too_big. While meta.hasMore is true, pass meta.nextCursor as cursor with the same search and category; a cursor from another route, other parameters or another credential, or altered, is 400. The list never answers meta.partial. A repeated parameter, a category or search over 200 characters, or a malformed limit or cursor is 400 bad_request.

What is withheld

Never who created a template. Creating an agent from a template stays in the Console.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

category
string

Only templates in this category.

Required string length: 1 - 200

Templates whose name matches these words, best match first.

Required string length: 1 - 200
limit
integer
default:50

Items per page, 1 to 100 (default 50); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 100
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Agent templates

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.