Skip to main content
POST
Remove Agents from Group
Use this API to remove one or more agents from a group.
This operation is idempotent: removing an agent that is not a member is a silent success. Removal uses arrayRemove, so it never throws for absent ids. The agents themselves are not deleted; only their membership in this group is removed.

Endpoint

POST https://api.velt.dev/v2/agents/groups/remove-agents

Headers

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

Body

Params

data
object
required

Example Requests

Response

Success Response

Returns the updated group document.

Failure Response

Errors:
  • NOT_FOUND: the group does not exist.
  • INVALID_ARGUMENT: empty agentIds array or empty id values.