AgentPayload - Orkeia AI

No Orkeia, o AgentPayload define como você envia uma requisição ao agente em tempo de execução.

export interface AgentPayload {
  agent: string;
  input: string;
  context?: { role: 'user' | 'assistant'; content: string }[];
  chatId?: string;
  files?: string[];
  metadata?: Metadata;
}

export interface Metadata {
  useCache: boolean;
  hoursCache: number;
}

Tabela de campos — `AgentPayload`

Campo	Tipo	Obrigatório	Descrição	Exemplo
agent	string	Sim	Identificador do agente cadastrado.	”Suporte Orkeia”
input	string	Sim	Prompt/mensagem do usuário	”Quais são os planos e valores?“
context	objeto, conforme exemplo abaixo	Não	Histórico de turnos para continuidade. Podendo alternar entre usuario e assistente	Vide exemplo abaixo
chatId	string	Não	ID da conversa para persistência	”chat1234”
files	string	Não	URLs/paths de anexos	”www.arquivo.com”
metadata	Metadata	Não	Controle de cache na borda	vide exemplo abaixo

Exemplo de objeto de context:

context: { 
	role: 'user' | 'assistant';
	content: string;
}[]

Exemplo de context:

[
	{
		"role":"user",
		"content":"oi"
	}
]

Exemplo de Metadata

{
	"useCache": true, "hoursCache": 6} 

Tabela de campos — `Metadata`

Campo	Tipo	Obrigatório	Descrição	Exemplo
useCache	boolean	✅	Se verdadeiro, permite reuso de resposta.	true
hoursCache	number	✅	Janela de validade do cache (em horas).	6

Exemplo JSON — chamada mínima

{
  "agent": "Suporte Orkeia",
  "input": "Preciso de ajuda com a fatura"
}

Exemplo JSON — chamada completa (com histórico e cache)

{
  "agent": "Suporte Orkeia",
  "input": "Quais são os planos e valores?",
  "context": [
    { "role": "user", "content": "Olá!" },
    { "role": "assistant", "content": "Oi! Como posso ajudar?" }
  ],
  "chatId": "chat_12345",
  "files": ["https://storage.orkeia.ai/docs/termos.pdf"],
  "metadata": {
    "useCache": true,
    "hoursCache": 12
  }
}