Skip to main content
POST
Update Agent Group
Use this API to update a group’s name and/or description. Membership and metadata cannot be changed via this endpoint: The schema uses .strict() so any unknown field (including agentIds and metadata) is rejected with a clear validation error. At least one of name or description must be provided — empty updates are rejected.

Endpoint

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

Headers

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

Body

Params

data
object
required
At least one of name or description is required.

Example Requests

1. Rename a group

2. Update name and description

Response

Success Response

Failure Response

Errors:
  • NOT_FOUND — group does not exist
  • INVALID_ARGUMENT — neither name nor description provided, or unknown field sent (e.g. agentIds, metadata)