Update Agent (Identity)

POST /v2/agents/update

Update Agent (Identity)

cURL

curl --request POST \
  --url https://api.velt.dev/v2/agents/update \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "agentId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "enabled": true
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Agent updated successfully",
    "data": {
      "agentId": "abc123def456"
    }
  }
}

Use this API to update identity fields (name, description, enabled) on the root agent document. No new version is created. Use Update Agent Version for behavioral edits.

Works for both custom and built-in agents, but built-in agents only support updating enabled. 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

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

agentId · string · required

Min 1 char. Agent ID to update (custom or built-in).

name · string

Min 1 char. New display name. Not allowed for built-in agents.

description · string

New human-readable description. Not allowed for built-in agents.

enabled · boolean

Whether the agent is active.

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

Example Requests

1. Rename a custom agent

{
  "data": {
    "agentId": "abc123def456",
    "name": "Updated Brand Checker",
    "description": "Now also checks footer typography"
  }
}

2. Disable an agent

{
  "data": {
    "agentId": "abc123def456",
    "enabled": false
  }
}

3. Enable a built-in agent

{
  "data": {
    "agentId": "spell-check",
    "enabled": true
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Agent updated successfully",
    "data": {
      "agentId": "abc123def456"
    }
  }
}

Field	Type	Description
data.agentId	string	The ID of the updated agent

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Errors: INVALID_ARGUMENT (sending name or description for a built-in agent — only enabled is allowed) / NOT_FOUND (agent does not exist).

{
  "result": {
    "status": "success",
    "message": "Agent updated successfully",
    "data": {
      "agentId": "abc123def456"
    }
  }
}