Update Agent
Update an existing agent
Documentation Index
Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Body
Agent update input
The OId of the agent to update
1"agent_123"
The name of the agent
The description of the agent
The model to use for the agent
NOTE, PULSE, ECHO, HARMONY, CHORUS, SYMPHONY The OId of the product/offering to associate with the agent
Alias for productOId — use either field, not both. Maps to the same internal product/offering.
The OId of the playbook to associate with the agent
The OIds of the personas to associate with the agent
The OIds of the use cases to associate with the agent
The OIds of the segments to associate with the agent
The OIds of the competitors to associate with the agent
The OIds of the reference customers to associate with the agent
The OIds of the proof points to associate with the agent
Whether to enable brand voice for the agent
Whether to enable web search. Only enable when explicitly requested
Custom instructions for the web search tool
Whether to enable CRM activity for the agent
Custom instructions for the CRM activity tool
Whether to enable high-effort mode for the agent
EMAIL agents only: sequence-level settings (type, numEmails, tone, reading level, instructions, writingStyleOId, etc.)
EMAIL agents only: map of 1-based step index to partial email builder config (same numbering as sequence run runtimeContext keys). Deep-merged into writingStyle.emails[i] after update. trainingExamples.targetTrainingIndex is 1-based (default 1).
Call prep methodology (CALL_PREP agents only). Controls discovery questions and call script framing.
BANT, SPIN, CHAMP, MEDDIC, SANDLER, CHALLENGER, AIDA, NEAT, SPICED, WHY_CHANGE Instructions for content generation (CONTENT agents only)
Example outputs for content generation (CONTENT agents only)
The output format for content generation (CONTENT agents only)
JSON, TEXT, HTML, MARKDOWN JSON schema instructions for content generation (CONTENT agents only, used with JSON output format)
Full agent configuration data passthrough. When provided, this will be merged with the simplified fields above, with simplified fields taking precedence.