Edit Agent

Updates an existing Agent's details using its unique agent_id.
This endpoint enables modifications to an agent's name, description, settings, and configurations.
The updated information is returned upon a successful request.

Purpose of This Endpoint

Allows users to modify agent details without creating a new agent.

Helps in keeping agents updated with name, descriptions, or project assignments.

Supports customizing an agent’s functionality by adjusting parameters.

Required Parameter

agent_id (string, required) – The unique identifier of the agent that needs to be updated.

Where to Find Your Agent ID?

If you don’t know the Agent ID, you can find it by following this guide:
👉 View Your Agent ID

Request Body Requirements

The request body should contain only the fields that need to be updated.
For instance:

project_id (string, optional) – Assigns or reassigns the agent to a specific project.

name (string, optional) – The new name for the agent.

description (string, optional) – A brief description of the agent’s purpose.

What Happens After an Update?

The response will contain the updated agent’s details, reflecting the changes.

Only the fields provided in the request body will be modified; others remain unchanged.

Step-by-Step Guide of Edit Agents

To follow a detailed, step-by-step guide on How to Edit an agent, visit:
Edit Agents Guide

To retrieve an agent’s current details, use the Get Agent endpoint.

To list all available agents, use the Get All Agents endpoint.

For more detailed information about agent, refer to the Agent Guide.

📝 Note: "Assistant" is another name for "Agent".

curl --location --request PUT '/v2/api/agent/' \ --form 'project_id="2"' \ --form 'name="updated"' \ --form 'description=""' \ --form 'sample_q1=""' \ --form 'sample_q2=""' \ --form 'sample_q3=""' \ --form 'status="Live"' \ --form 'type="1"' \ --form 'prefix_prompt="abc"' \ --form 'custom_instructions="[]"' \ --form 'access="Only me"' \ --form 'create_email_alias="true"' \ --form 'cloned_from=""' \ --form 'llm_model="1"' \ --form 'character_voice_id="1"'

{ "success": true, "message": "Agent data updated successfully", "data": { "id": 1, "agent_type": { "id": 1, "created_by": "System", "created_on": "2024-08-23T21:38:47.044052Z", "modified_by": "", "modified_on": "2024-08-23T21:38:47.044079Z", "name": "testAgent", "description": "i am testing" }, "instructions": [], "user": { "id": 2, "email": "user@example.com", "first_name": "Ejento", "last_name": "Admin" }, "agent_name": "updated", "industry_area": "Online Marketing", "domain": "", "prefix_prompt": "abc", "access": "Only me", "status": "Live", "project": 1, "llm_config": 1, "created_by": "user@example.com", "created_on": "2024-08-23T21:39:12.471584Z" } }

Purpose of This Endpoint#

Required Parameter#

Where to Find Your Agent ID?#

Request Body Requirements#

What Happens After an Update?#

Step-by-Step Guide of Edit Agents#

Related API Endpoints#

Request