Agent custom instructions API
Learn about agent custom instructions, how they affect an agent's responses, and how users can access and manage them through public APIs.
The Agent custom instructions allows you to specify custom instructions, which provide additional guidance for an agent's responses. Instructions are stored per user and agent, so the Agent custom instructions retrieve or update the authenticated user's instruction for the selected agent.
How custom instructions APIs work
Use the following APIs to retrieve and update custom instructions for your agents:
Get an agent's custom instructions: Retrieves your current custom instruction, its administrator lock status, and the time of its last update.
Update an agent's custom instructions: Replaces or clears your saved custom instruction. It also supports encoded and chunked payloads for large instructions.
Content guardrails help ensure that custom instructions comply with Reltio's usage policy. Instructions that conflict with the policy are rejected without changing the saved instruction. If a tenant administrator has locked an agent's user-defined custom instructions, the Update an agent's custom instructions rejects requests to change your instruction for that agent.
For large instructions, updates are saved only after the complete payload is received and passes validation.