Update Agent Group

POST /v2/agents/groups/update

Update Agent Group

cURL

curl --request POST \
  --url https://api.velt.dev/v2/agents/groups/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": {
    "groupId": "<string>",
    "name": "<string>",
    "description": "<string>"
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Agent group updated successfully",
    "data": {
      "group": {
        "id": "grp_9f3ac2",
        "name": "Brand & Visual QA",
        "agentIds": [],
        "metadata": { "apiKey": "ak_xxx" },
        "createdAt": 1711900000000,
        "updatedAt": 1711950000000
      }
    }
  }
}

Use this API to update a group’s name and/or description. Membership and metadata cannot be changed via this endpoint:

• For membership changes, use Add Agents to Group and Remove Agents from Group.
• metadata is immutable after creation — set it on Create Group.

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

Your Auth Token.

Body

Params

data · object · required

Show properties

groupId · string · required

Trimmed, non-empty. Agent group id.

name · string

Trimmed, non-empty. Capped at MAX_GROUP_NAME_LENGTH.

description · string

Trimmed. Capped at MAX_GROUP_DESCRIPTION_LENGTH.

At least one of name or description is required.

Example Requests

1. Rename a group

{
  "data": {
    "groupId": "grp_9f3ac2",
    "name": "Brand & Visual QA"
  }
}

2. Update name and description

{
  "data": {
    "groupId": "grp_9f3ac2",
    "name": "Brand & Visual QA",
    "description": "Brand consistency, color, typography, and layout agents"
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Agent group updated successfully",
    "data": {
      "group": {
        "id": "grp_9f3ac2",
        "name": "Brand & Visual QA",
        "description": "Brand consistency, color, typography, and layout agents",
        "agentIds": ["abc123def456", "spell-check"],
        "metadata": { "apiKey": "ak_xxx" },
        "createdAt": 1711900000000,
        "updatedAt": 1711950000000
      }
    }
  }
}

Failure Response

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

Errors:

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

{
  "result": {
    "status": "success",
    "message": "Agent group updated successfully",
    "data": {
      "group": {
        "id": "grp_9f3ac2",
        "name": "Brand & Visual QA",
        "agentIds": [],
        "metadata": { "apiKey": "ak_xxx" },
        "createdAt": 1711900000000,
        "updatedAt": 1711950000000
      }
    }
  }
}