Update Agent

Update an existing AI agent with new configuration and knowledge sources. This endpoint allows you to modify the agent's settings, such as its name, description, behavior, and model configuration.

Overview

The Update Agent endpoint enables you to modify an existing AI agent's properties. You can update fields like the agent's name, description, system prompt, appearance, behavior, and model settings to tailor the agent to your evolving needs.

Parameters

Error Responses

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent with ID 11 not found.",
    "status": 404,
    "fields": []
  }
}

Best Practices

• Partial Updates: Only include the fields you want to update in the request body to avoid unintentionally resetting other fields. Use PATCH method to partial update.
  PATCH/v1/agents/{id}

  Request Body

  jsonCopy

  {
    "appearance": {
      "aiToAiHandoff": true
    }
  }

• System Prompts: Ensure the system prompt is clear and aligns with the agent's updated purpose.
• Testing: Test the updated agent thoroughly to verify that changes behave as expected.
• Rate Limits: Be mindful of the rate limits when updating multiple agents in succession.

Rate Limits

• 100 requests per minute for free tier
• 1000 requests per minute for pro tier
• 10000 requests per minute for enterprise tier