API reference
AgentDefinition
An agent as a document: everything about how it behaves, and everything outside it by name
An agent as a document: everything about how it behaves, and everything outside it by name.
The console's own export format, so a file exported from one and a definition read from the
other are the same thing. No credential, no id of another object, no phone number and no domain
travels in it: tools, knowledge bases, a calendar and a callback agent are named in
references and bound by name where the definition lands.
| Field | Type | Description |
|---|---|---|
agent |
object | Its name, kind, direction, channels, prompt, configuration, voice, languages, analysis and knowledge settings. |
exported_at |
string (date-time) | |
format |
string | The document's version, agently.agent/1. |
object |
agent_definition |
|
references |
object | Everything outside the agent it uses, by name: tools, knowledge_bases, calendar, callback_agent, and the knowledge each specialist or language narrows to. |