Skip to main content
POST
Update Agent (Identity)
Use this API to update identity fields on the root agent document. No new version is created. Works for both custom and built-in agents, though built-in agents only support updating enabled. For behavioral changes (instructions, context gathering, execution, post-processing, scope), use Update Agent Version instead, which creates a new version. Server-managed fields (id, apiKey, managedBy, metadata, version, createdAt, updatedAt) cannot be set through this endpoint.

Endpoint

POST https://api.velt.dev/v2/agents/update

Headers

string
required
Your API key.
string
required

Body

Params

object
required
At least one of name, description, or enabled should be provided.

Example Requests

1. Rename an agent

2. Disable an agent

3. Enable a built-in agent

Response

Success Response

Failure Response

Errors: INVALID_ARGUMENT (missing agentId, empty name, or sending name/description for a built-in agent; built-in agents only support the enabled field) / NOT_FOUND (agent does not exist).