Delete Agent Group

POST /v2/agents/groups/delete

Delete Agent Group

cURL

curl --request POST \
  --url https://api.velt.dev/v2/agents/groups/delete \
  --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>"
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Agent group deleted successfully",
    "data": {
      "groupId": "grp_9f3ac2"
    }
  }
}

Use this API to delete an agent group document. The agents referenced by the group are not affected — they remain intact in the workspace’s custom agent collection.

To delete a custom agent (and have it removed from every group), use Delete Agent.

Endpoint

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

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.

Example Requests

Delete a group

{
  "data": {
    "groupId": "grp_9f3ac2"
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Agent group deleted successfully",
    "data": {
      "groupId": "grp_9f3ac2"
    }
  }
}

Field	Type	Description
data.groupId	string	The ID of the deleted group

Failure Response

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

Errors: NOT_FOUND (group does not exist).

{
  "result": {
    "status": "success",
    "message": "Agent group deleted successfully",
    "data": {
      "groupId": "grp_9f3ac2"
    }
  }
}