Skip to main content
PUT
https://jwhite.tail8bf327.ts.net
/
api
/
v1
/
agents
/
{id}
Update Agent
curl --request PUT \
  --url https://jwhite.tail8bf327.ts.net/api/v1/agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "avatar_id": 123,
  "language": "<string>",
  "custom_greeting": "<string>",
  "context": "<string>",
  "properties": {},
  "memories": {},
  "knowledge_base": {},
  "status": "<string>"
}
'
{
  "success": true
}

​
Authentication

Requires JWT authentication (cookie-based) or API key authentication. 
Authorization: Bearer <jwt_token>

​
Parameters

​
id
integer
required
The ID of the agent to update

​
Request Body

All fields are optional. Only include the fields you want to update.
​
name
string
Agent name
​
avatar_id
integer
Avatar ID for the AI assistant. The voice will come from the avatar.
​
language
string
Language code (e.g., ‘en’, ‘es’, ‘fr’)
​
custom_greeting
string
Custom greeting message for the AI assistant
​
context
string
Additional context or instructions for the AI
​
properties
object
Custom properties (JSON object)
​
memories
object
Agent memories (JSON object)
​
knowledge_base
object
Knowledge base content (JSON object)
​
status
string
Agent status (‘active’, ‘archived’)

​
Request

PUT https://jwhite.tail8bf327.ts.net/api/v1/agents/123
Authorization: Bearer <jwt_token>
Content-Type: application/json

{
  "name": "Updated Sales Support Agent",
  "custom_greeting": "Hello! How may I assist you?",
  "context": "You are an expert sales assistant."
}

​
Response

{
  "success": true
}

{
  "error": "Agent not found"
}

​
Notes

  • Only the fields included in the request body will be updated
  • The updated_at timestamp is automatically updated
  • You must own the agent to update it (user_id must match)
  • At least one field must be provided for update

​
Error Responses

For information about error responses and status codes, see Error Responses.

​
Common Errors for This Endpoint

  • 400 Bad Request - No fields to update or invalid field values
  • 401 Unauthorized - Invalid or missing authentication
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Agent not found
  • 500 Internal Server Error - Server error