Get Agent Group

POST /v2/agents/groups/get

Get Agent Group

cURL

curl --request POST \
  --url https://api.velt.dev/v2/agents/groups/get \
  --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 fetched successfully",
    "data": {
      "group": {
        "id": "grp_9f3ac2",
        "name": "Brand QA",
        "agentIds": [],
        "metadata": { "apiKey": "ak_xxx" },
        "createdAt": 1711900000000,
        "updatedAt": 1711900000000
      }
    }
  }
}

Use this API to fetch a single agent group by id. Returns the full group document including the complete agentIds array.

For a paginated overview of all groups in the workspace (returns agentCount instead of agentIds), use List Groups.

Endpoint

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

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

Get a group

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

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Agent group fetched successfully",
    "data": {
      "group": {
        "id": "grp_9f3ac2",
        "name": "Brand QA",
        "description": "All brand-quality agents",
        "agentIds": ["abc123def456", "spell-check"],
        "metadata": {
          "apiKey": "ak_xxx",
          "organizationId": "server_org_001",
          "documentId": "server_doc_001"
        },
        "createdAt": 1711900000000,
        "updatedAt": 1711900000000
      }
    }
  }
}

Failure Response

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

Errors: NOT_FOUND (group does not exist) / INVALID_ARGUMENT (missing or empty groupId).

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