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.

Endpoint

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

Headers

x-velt-api-key
string
required
Your API key.
x-velt-auth-token
string
required

Body

Params

data
object
required
Provide at least one of name, description, or enabled. This is not schema-enforced — a request without any of them succeeds as a no-op for custom agents, and returns INVALID_ARGUMENT for built-in agents (which require enabled).

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 updating a built-in agent without the enabled field — built-in agents only support enabled, and name/description sent alongside enabled are silently ignored) / NOT_FOUND (agent does not exist).