Saltar al contenido principal
En Orkeia, el AgentPayload define cómo envías una solicitud al agente en tiempo de ejecución.

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;
}

Tabla de campos — AgentPayload

CampoTipoObligatorioDescripciónEjemplo
agentstringIdentificador del agente registrado.”Soporte Orkeia”
inputstringPrompt/mensaje del usuario”¿Cuáles son los planes y valores?“
contextobjeto, según ejemplo abajoNoHistorial de turnos para continuidad. Puede alternar entre usuario y asistenteVéase ejemplo abajo
chatIdstringNoID de la conversación para persistencia”chat1234”
filesstringNoURLs/paths de archivos adjuntoswww.archivo.com
metadataMetadataNoControl de caché en el bordevéase ejemplo abajo
Ejemplo de objeto de context:
context: { 
	role: 'user' | 'assistant';
	content: string;
}[]
Ejemplo de context:
[
	{
		"role":"user",
		"content":"hola"
	}
]
Ejemplo de Metadata
{
	"useCache": true, "hoursCache": 6} 

Tabla de campos — Metadata

CampoTipoObligatorioDescripciónEjemplo
useCachebooleanSi es verdadero, permite reutilizar la respuesta.true
hoursCachenumberVentana de validez del caché (en horas).6

Ejemplo JSON — llamada mínima

{
  "agent": "Soporte Orkeia",
  "input": "Necesito ayuda con la factura"
}

Ejemplo JSON — llamada completa (con histórico y caché)

{
  "agent": "Soporte Orkeia",
  "input": "¿Cuáles son los planes y valores?",
  "context": [
    { "role": "user", "content": "¡Hola!" },
    { "role": "assistant", "content": "¡Hola! ¿Cómo puedo ayudar?" }
  ],
  "chatId": "chat_12345",
  "files": ["https://storage.orkeia.ai/docs/termos.pdf"],
  "metadata": {
    "useCache": true,
    "hoursCache": 12
  }
}