Voxxi

Categories

Reference documentation for Categories.

Endpoints

GET/categories

List categories

Returns call categories available to the authenticated organization.

Request

GET
/categories
curl -X GET https://app.voxxi.ai/api/external/v1/categories \
  -H "Authorization: Bearer {token}"

200 Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "icon": "string",
      "createdAt": "2026-01-01T00:00:00Z",
      "updatedAt": "2026-01-01T00:00:00Z"
    }
  ]
}
GET/categories/{categoryId}

Get category detail

Returns category metadata and the complete analysis configuration for the authenticated organization.

Required parameters

  • Name
    categoryId
    Type
    string, required
    Description

    Category id.

Request

GET
/categories/{categoryId}
curl -X GET https://app.voxxi.ai/api/external/v1/categories/categoryId \
  -H "Authorization: Bearer {token}"

200 Response

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z",
    "intendedPurpose": "string",
    "additionalLLMContext": "string",
    "possibleOutcomes": [
      {
        "id": "string",
        "label": "string",
        "description": "string",
        "isSuccess": true,
        "isNotApplicable": true
      }
    ],
    "analysisPointers": [
      {
        "id": "string",
        "sectionId": "string",
        "sectionName": "string",
        "criterias": [
          {
            "id": "string",
            "criteriaId": "string",
            "question": "string"
          }
        ]
      }
    ],
    "extractionFields": [
      {
        "id": "string",
        "fieldName": "string",
        "displayName": "string",
        "fieldType": "string",
        "enumOptions": [
          {
            "value": "string",
            "hint": "string"
          }
        ],
        "enumValues": [
          "string"
        ],
        "description": "string",
        "required": true
      }
    ],
    "targetingRules": [
      {
        "targetType": "section",
        "targetId": "string",
        "expression": null
      }
    ],
    "tagTargets": [
      {
        "id": "string",
        "slug": "string",
        "displayName": "string"
      }
    ]
  }
}