Pular para o conteúdo principal
POST
/
agents
/
{id}
/
execute
Executar Agente
curl --request POST \
  --url https://api.example.com/agents/{id}/execute/

Documentation Index

Fetch the complete documentation index at: https://docs.orkeia.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

POST https://gateway.orkeia.ai/agents/{id}/execute

​
Cabeçalhos

authorization:  <seu_token>
Content-Type: application/json

​
Parâmetros de caminho

Necessario passar via query params o id do agente 
{
  "id": "ID do agente (obrigatório)"
}

​
Request body

{
  "agent": "id do agente",
  "input": "prompt",
  "context": [{
    "role": ["user","assistant"],
    "content": "conteúdo do contexto"
  }],
  "chatId": "id do chat, se houver",
  "files": "array de arquivos, se houver",
  "metadata": Metadata,
}
Esse request é o nosso AgentPayload! Caso tenha alguma dúvida a respeito, recomendamos que de uma olhada nesse link.

​
Exemplo (cURL)

curl -X POST "https://gateway.orkeia.ai/agents/agent123/execute" \
  -H "authorization:  <seu_token>" \
  -H "Content-Type: application/json" \
  -d '{ "action": "processar"}'

​
Respostas

​
Response - Success

response
{
  "status": "OK",
  "data": { 
	"response" : "resultado do processamento", 
    "chatId": "id do chat", 
    "file": "caminho do arquivo, se houver"}
   }
}

​
500 — Bad Request

{
  "status": "ERROR",
  "code": "server/error",
  "data": null
}

​
400 — Client Error

{
  "status": "ERROR",
  "code": "client/error",
  "data": null
}