Skip to main content
PUT
/
api
/
v1
/
agents
/
{id}
Update Agent
curl --request PUT \
  --url https://api.example.com/api/v1/agents/{id}
Update an existing AI agent’s configuration.

Request

PUT /api/v1/agents/{id}
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Path Parameters

ParameterTypeRequiredDescription
idstringYesUUID of the agent

Body Parameters

All fields are optional. Only include fields you want to update.
ParameterTypeDescription
namestringDisplay name
descriptionstringDescription
configobjectProvider-specific configuration
is_activebooleanWhether the agent is active

Response

Returns the updated agent object.
FieldTypeDescription
idstringAgent UUID
providerstringProvider type
namestringDisplay name
descriptionstringDescription (or null)
is_activebooleanWhether the agent is active
created_atstringISO-8601 creation timestamp
updated_atstringISO-8601 last update timestamp

Examples

curl -X PUT "https://app.preclinical.dev/api/v1/agents/uuid" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Healthcare Assistant v2",
    "is_active": true
  }'

Success Response

{
  "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "provider": "vapi",
  "name": "Healthcare Assistant v2",
  "description": "Production voice agent for patient triage",
  "is_active": true,
  "created_at": "2026-01-15T08:00:00Z",
  "updated_at": "2026-01-30T14:00:00Z"
}

Errors

CodeDescription
AGENT_NOT_FOUNDAgent not found or doesn’t belong to your organization
INVALID_FIELD_VALUEInvalid value for a field