GET /v1/agent-templates
GET
/v1/agent-templates
const url = 'https://seu-endereco-da-api/v1/agent-templates';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/agent-templates \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler agentes de IA (agents:read).
Authorizations
Seção intitulada “Authorizations”Responses
Seção intitulada “Responses”Media typeapplication/json
object
categories
required
Active categories in filter order
Array<object>
object
key
required
string
name
required
string
templates
required
Array<object>
object
slug
required
string
icon
required
Key of the closed icon catalog the gallery draws
string
name
required
string
area
required
string
tagline
required
string
persona
required
object
name
required
Name the agent introduces itself with
string
avatar
required
Https address of the agent picture
string
preview
required
The first customer message of the example conversation and the agent reply to it, for the gallery card
Array<object>
object
from
required
string
text
required
string
searchText
required
What the template does and its whole example conversation, so the gallery search finds it by task
string
category
required
object
key
required
string
name
required
string
version
required
The published version an agent created now would get
number
requirements
required
Array<object>
object
key
required
string
label
required
string
optional
required
The template works without it, with less
boolean
missing
required
The account does not have it yet: the gallery shows it in orange with Connect
boolean
setUpInWizard
required
Belongs to the agent being created (knowledge): the setup wizard prepares it, so it is never missing
boolean
connectTarget
required
Stable key of the screen where the owner connects it
string
Example
{ "templates": [ { "icon": "sparkles", "preview": [ { "from": "contact" } ], "requirements": [ { "key": "asaas" } ] } ]}