Mensagem Generativa Efêmera

Este terminal lida com a criação de mensagens generativas efêmeras para agentes na plataforma.

[POST] Criar

Gerencia uma resposta passando o contexto.

Requisição

curl --location 'https://api.zaia.app/v1.1/api/ephemeral-generative-message/create' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <sua chave de api aqui>' \
--data '{
  "agentId": 123,
  "context": [
    {
      "origin": "user",
      "text": "Olá"
    },
    {
      "origin": "assistant",
      "text": "Ei, sou a Bianca da Zaia, como posso ajudá-lo hoje?"
    }
  ],
  "prompt": "Explique mais sobre você...",
  "streaming": false
}'

Headers (Cabeçalhos)

Chave	Tipo	Exemplo	Obrigatório
Authorization	String	Bearer <sua chave aqui>	✓

Body (Corpo)

Chave	Tipo	Exemplo	Obrigatório
agentId	Number	123	✓
context	Array< Context >	[Clique aqui]	✓
prompt	String	Explique mais sobre você...	✓
streaming	Boolean	false

Context

Chave	Tipo	Exemplo
origin	String	assistant | user
text	String	Ei, sou a Bianca da Zaia, como posso ajudá-lo hoje?

Exemplo de contexto:

"context": [
  {
    "origin": "user",
    "text": "Olá"
  },
  {
    "origin": "assistant",
    "text": "Ei, sou a Bianca da Zaia, como posso ajudá-lo hoje?"
  }
]

Respostas

🟢 200 → OK

Chave	Tipo	Exemplo
createdAt	Date	2024-06-17T16:29:11.338Z
id	Number	3
model	String	gpt-4
text	String	Eu sou Bianca, sua assistente virtual aqui para ajudar com suas perguntas e solicitações.
chatStage	Object	[Clique aqui]
Files	Array<File>	[Clique aqui]

ChatStage

Chave	Tipo	Exemplo
id	String	94f7efc5b8de42ff85ad53eb8414c46d
condition	String	When user...
name	String	stage name
objective	String	stage objective

File

Chave	Tipo	Exemplo
data	String	base64 string
type	String	image/png ou image/jpeg ou application/pdf
name	String	Nome do arquivo

Exemplo de resposta:

{
  "createdAt": "2024-06-17T16:29:11.338Z",
  "id": 3,
  "model": "gpt-4",
  "text": "Eu sou Bianca, sua assistente virtual aqui para ajudar com suas perguntas e solicitações.",
  "chatStage": {
    "condition": "user expresses interest in learning about artificial intelligence",
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "name": "AI Introduction",
    "objective": "provide a brief overview of artificial intelligence and its applications"
  },
  "files": [{
    "data": "base64 here!",
    "name": "file name",
    "type": "Examples: image

🔴 403 → Unauthorized

"Forbidden."

🔴 404 → Not Found

"Agent not found."