Zaia Docs
APIZaia AcademyComunidade no Discord
API
API
  • Introdução
    • Fundamentos APIS
      • 1.O que é um JSON e sua importância
      • 2.O Que é um Webhook?
      • 3.O Que é cURL?
      • 4.O Que é uma API?
  • Chat Generativo Externo
    • [GET] Buscar chat
    • [GET] Buscar múltiplos chats
    • [POST] Criar novo chat
  • Mensagem Generativa Externa
    • [PATCH] Resolve Takeover
    • [POST] Create
    • [GET] Retrieve Multiple
  • Mensagem entre canais
    • [POST] Envio de texto e imagem externas
  • Agente
    • [POST] Criar agente
    • [PATCH] Atualizar agente
    • [DELETE] Excluir agente
    • [GET] Buscar agentes
  • Estágios do Agente
    • [POST] Criar um estágio
    • [PATCH] Reorganizar estágios
    • [DELETE] Remover estágio
    • [GET] Listar estágios
    • [PATCH] Atualizar
  • Requisições HTTP de Estágio de Chat
    • [DELETE] Remover
    • [GET] Recuperar Múltiplos
    • [GET] Recuperar
    • [PATCH] Atualizar
  • Cérebro
    • [POST] Criar Crawler
    • [DELETE] Remover Crawler
    • [DELETE] Remover Múltiplos Crawlers
    • [POST] Treinar Crawler
    • [GET] Recuperar Múltiplos Crawlers
    • [POST] Treinar Arquivo
    • [DELETE] Remover Arquivo
    • [DELETE] Remover Múltiplos Arquivos
    • [GET] Recuperar Múltiplos Arquivos
  • Mensagem Generativa Efêmera
  • Consumo
Fornecido por GitBook
Nesta página
  • Requisição
  • Headers (Cabeçalhos)
  • Body (Corpo)
  • Respostas
  1. Agente

[POST] Criar agente

Cria um novo agente.

Requisição

curl --location --request POST 'https://api.zaia.app/v1.1/api/agent/create' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <your api key goes here>' \
--data '{
  "name": "The Zaian Agent",
  "template": "generic",
  "companyName": "Zaia",
  "fileQueryMode": "general",
  "pictureURL": "data:image/png;base64,iVBORw0KG...",
  "productDescription": "AI agents built for sales, support and more.",
  "tone": "Casual",
  "initialChatMessage": "Hello, I am The Zaian Agent. How can I assist you today?",
  "responseModel": "gpt-4o-mini",
  "voiceGender": "female"
}'

Headers (Cabeçalhos)

Chave
Tipo
Exemplo
Obrigatório

Authorization

String

Bearer <sua chave aqui>

✓

Body (Corpo)

Chave
Tipo
Exemplo
Obrigatório

name

String

The Zaian Agent

✓

template

TemplateEnum

generic

✓

companyName

String

Zaia

fileQueryMode

FileQueryModeEnum

general

pictureURL

String

data:image/png;base64,iVBORw0KG...

productDescription

String

AI agents built for sales, support and more.

tone

String

Casual

initialChatMessage

String

Hello, I am The Zaian Agent. How can I assist you today?

responseModel

ResponseModelEnum

gpt-4o-mini

voiceGender

VoiceGenderEnum

female

TemplateEnum
Tipo
Valores
Definição

String

generic

Um agente genérico para atender qualquer tipo de demanda.

String

salesman

Um agente especializado em vendas.

String

secretary

Um agente especializado em agendamentos e compromissos.

String

support

Um agente especializado em suporte e atendimento ao cliente.

FileQueryModeEnum
Tipo
Valores
Definição

String

generic

Ativa o modo de consulta indiscriminada. Todos os blocos são elegíveis.

String

scoped

Ativa o modo de consulta baseada em tags, onde apenas arquivos com tags relacionadas são elegíveis para consulta.

ResponseModelEnum
Tipo
Valores
Definição

String

gpt-4

Modelo GPT 4 da Open AI. Custa 20 créditos por mensagem.

String

gpt-4o

Modelo GPT 4o da Open AI. Custa 10 créditos por mensagem.

String

gpt-4o-mini

Modelo GPT 4o Mini da Open AI. Custa 1 crédito por mensagem.

String

claude-3.5

Modelo Claude Sonnet da Anthropic. Custa 5 créditos por mensagem.

String

gpt-3.5

Modelo GPT 3.5 da Open AI. Custa 1 crédito por mensagem.

String

llama-3

Llama 3 70B da Meta. Custa 1 crédito por mensagem.

VoiceGenderEnum
Tipo
Valores
Definição

String

male

Ativa a voz masculina para o agente.

String

female

Ativa a voz feminina para o agente.

Respostas

{
  "id": 1,
  "behavior": "...",
  "createdAt": "2024-02-14T12:00:00Z",
  "externalId": "...",
  "name": "The Zaian Agent",
  "template": "generic",
  "companyName": "Zaia",
  "fileQueryMode": "general",
  "pictureURL": "data:image/png;base64,iVBORw0KG…",
  "productDescription": "AI agents built for sales, support and more.",
  "tone": "Casual",
  "initialChatMessage": "Hello, I'm The Zaian Agent. How can I assist you?",
  "responseModel": "gpt-4o-mini",
  "voiceGender": "female"
}
"Unauthorized."

AnteriorAgentePróximo[PATCH] Atualizar agente

Atualizado há 2 meses