Edit Agent
PUT
/v2/api/agent/{agent_id}
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
Required Parameter
agent_id (string, required) – The unique identifier of the agent that needs to be updated.Where to Find Your Agent ID?
👉 View Your Agent ID
Request Body Requirements
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?
Step-by-Step Guide of Edit Agents
Edit Agents Guide
Related API Endpoints
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https:///v2/api/agent/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Example 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"
}
}Request
Path Params
Header Params
Body Params multipart/form-data