Update Agent Version (Behavioral)

POST /v2/agents/version/update

Update Agent Version (Behavioral)

cURL

curl --request POST \
  --url https://api.velt.dev/v2/agents/version/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>",
    "rawInstructions": "<string>",
    "instructions": "<string>",
    "phaseTimeoutMs": 123,
    "contextGathering": {},
    "execution": {},
    "response": {},
    "postProcess": {},
    "input": {},
    "scope": {},
    "setup": {}
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Agent version created successfully",
    "data": {
      "version": 4
    }
  }
}

Use this API to update behavioral/version fields on a custom agent. Creates a new version N+1 in the versions subcollection, updates the version pointer on the root document, and bumps updatedAt.

In-flight executions stay pinned to whatever version they started on — the update only affects future executions.

The schema uses .passthrough() so additional behavioral fields are forwarded. Deep validation happens in the service layer via updateCustomAgentConfigSchema.

Custom agents only. Use Update Agent for identity edits on built-in agents.

Endpoint

POST https://api.velt.dev/v2/agents/version/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. Custom agent ID.

rawInstructions · string

Original user-provided instructions.

instructions · string

Processed/enhanced instructions.

phaseTimeoutMs · number

Per-phase timeout in milliseconds (positive integer).

contextGathering · object

Context gathering config. Same shape as Create Agent.

execution · object

Execution config. Same shape as Create Agent.

response · object

Response formatting config. Same shape as Create Agent.

postProcess · object

Post-processing pipeline config. Same shape as Create Agent.

input · object

Input declaration config. Same shape as Create Agent.

scope · object

Scope and targeting config. Same shape as Create Agent.

setup · object

Setup assistant metadata. Same shape as Create Agent.

Example Requests

1. Update instructions and post-processing

{
  "data": {
    "agentId": "abc123def456",
    "instructions": "Check headings use 'Inter' font. Verify #1A73E8 on all CTAs and links.",
    "postProcess": {
      "guardrails": { "enabled": true },
      "matchAndMerge": { "enabled": true }
    }
  }
}

2. Update context gathering strategies

{
  "data": {
    "agentId": "abc123def456",
    "contextGathering": {
      "strategies": ["web-page-text", "web-page-html", "web-page-screenshot"]
    }
  }
}

3. Enable cross-page execution

{
  "data": {
    "agentId": "abc123def456",
    "scope": {
      "crossPage": {
        "enabled": true,
        "targetProperty": "brandConsistency",
        "pageDiscovery": "manual",
        "pages": ["https://example.com", "https://example.com/about"]
      }
    }
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Agent version created successfully",
    "data": {
      "version": 4
    }
  }
}

Field	Type	Description
data.version	number	New version number after the update

Failure Response

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

Errors: NOT_FOUND (agent does not exist) / INVALID_ARGUMENT (validation failure or attempting to update a built-in agent’s behavior).

{
  "result": {
    "status": "success",
    "message": "Agent version created successfully",
    "data": {
      "version": 4
    }
  }
}