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

string
required
Your API key.
string
required

Body

Params

object
required

Example Requests

Response

Success Response

Returns the updated group document, the same shape as Get Group. System groups carry system: true; groups you created omit the field.

Failure Response

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