Examples
Request
Parameters
Agent name (3-100 characters).
Description of the agent’s purpose and capabilities.
LLM model to use. We support OpenAI models.
System prompt that defines the agent’s behavior and personality.
Maximum number of knowledge base chunks to include in context.
Whether to inject knowledge base context into conversations.
Knowledge base slug to use for context (required if useContext is true).
Response
Returns
Unique slug for the agent (used in API calls).
Complete agent configuration object.
Unique agent identifier.
URL-friendly unique identifier for the agent.
Display name of the agent.
Description of the agent’s purpose and capabilities.
Agent status (active, inactive, etc.).
The LLM model used by the agent.
System prompt that defines the agent’s behavior and personality.
Temperature setting for response randomness (0.0-2.0).
Whether knowledge base context injection is enabled.
Slug of the connected knowledge base (if any).
Maximum number of knowledge base chunks to include in context.
Organization that owns this agent.
Additional custom metadata.
Timestamp when the agent was created.
Timestamp when the agent was last updated.