Skip to main content
POST
List Agent Groups
Use this API to list all agent groups in the workspace. Returns IAgentGroupSummary[] — the full agentIds array is intentionally stripped from each row and replaced with an agentCount field, so list payloads stay O(1) per group regardless of group size. To fetch the complete agentIds array for a specific group, call Get Group.

Endpoint

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

Headers

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

Body

Params

data
object
required
Empty object — only the apiKey (injected from headers) is required.

Example Requests

List all groups

Response

Success Response

Each summary contains id, name, description?, agentCount, metadata, createdAt, updatedAt. The full agentIds array is omitted; fetch it via Get Group.

Failure Response