Pular para o conteúdo

GET /v1/agent-templates/{slug}

GET
/v1/agent-templates/{slug}
curl --request GET \
--url https://seu-endereco-da-api/v1/agent-templates/example \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler agentes de IA (agents:read).

slug
required
string
Media typeapplication/json
object
slug
required
string
icon
required

Key of the closed icon catalog the gallery draws

string
Allowed values: sparkles chat calendar banknotes credit-card receipt chart star heart arrow-path user-plus funnel briefcase trophy clipboard-check megaphone shopping-cart truck phone lifebuoy shield-check academic-cap home
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
Allowed values: contact agent
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
Allowed values: asaas calendar pipeline catalog csat marketing_template knowledge payment_template google_calendar
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
greeting
required

First message of the template, so the test chat starts as the agent would

string
exampleConversation
required

Messages { from: contact | agent, text }

Array<object>
object
key
additional properties
any
does
required

{ conversation: string[], system: string[] }

object
key
additional properties
any
testQuestions
required

{ question, expected }

Array<object>
object
key
additional properties
any
questions
required

At most 3 { key, label, suggestions by business type, target }

Array<object>
object
key
additional properties
any
handoffTo
required

Template suggested to take the conversation when this one finishes

object
slug
required
string
name
required
string

Example

{
"icon": "sparkles",
"preview": [
{
"from": "contact"
}
],
"requirements": [
{
"key": "asaas"
}
]
}