Skip to main content
POST
/
agents

​
Endpoint

POST https://gateway.orkeia.ai/agents

​
Headers

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

​
Request Body (JSON)

All fields below are required
FieldTypeDescription
namestringName of the agent
enabledbooleanWhether the agent is active
modelstring / ModelID of the model or AI model
autobooleanWhether the agent is active
reasoningbooleanWhether the agent has permission to process thought
publisherstringID of who created the agent
temperaturenumber (0.0 to 1.0)Controls the randomness of the model’s responses. Values closer to 0 tend to be more deterministic, while closer to 1 tend to be more variable.
rolestringRole that the agent will play
objectivestringObjective of the agent in each interaction
referenciesstringTextual reference that the agent will use
can.delegatebooleanCan the agent delegate tasks?
can_codebooleanCan the agent program?
multimodalbooleanDoes the agent have the ability to interact with multiple modes (image, text, audio)?
sectorsarray(String)Array of sectors that will use the agent
toolsarray(String) / array(Tools)Array of tools that the agent can use
knowledgeBasesarray(String) / array(KnowledgeBase)Array of knowledge bases that can be used by the agent
Click here to learn more about Tools, Knowledge Bases, and AI Models!
{
  "name": "Agent Name",
  "enabled": "true",
  "model": "sabia-3",
  "auto": "false",
  "reasoning": "false",
  "publisher": "ork-123",
  "temperature": "1",
  "role": "content creator",
  "objective": "aims to perform such a task",
  "referencies": "reference text",
  "can.delegate": "false",
  "can_code": "false",
  "multimodal": "false",
  "sectors": ["market"],
  "tools": ["web_scrapper"],
  "knowledgeBases": ["market_base"]
}

​
Example (cURL)

curl -X POST "https://gateway.orkeia.ai/agents" \
  -H "authorization:  <your_token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Agent Name", "enabled": true,
  "model": "sabia-3",
  "auto": "false",
  "reasoning": "false",
  "publisher": "ork-123",
  "temperature": "0.3",
  "role": "content creator",
  "objective": "aims to perform such a task",
  "referencies": "reference text",
  "can.delegate": "false",
  "can_code": "false",
  "multimodal": "false",
  "sectors": ["market"],
  "tools": ["web_scrapper"],
  "knowledgeBases": ["market_base"]
  }'

​
Responses

​
Response - Success

response
{
  "status": "OK",
  "data": { "id": "string_id"}
}

​
500 — Bad Request

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

​
400 — Client Error

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