List custom categories | Resemble

{
  "success": true,
  "settings": {
    "use_builtin_categories": true
  },
  "built_in_categories": [
    {
      "id": 1,
      "name": "string",
      "icon": "string",
      "scenario_count": 1,
      "example_texts": [
        "string"
      ]
    }
  ],
  "custom_categories": [
    {
      "id": 1,
      "name": "string",
      "description": "string",
      "icon": "string",
      "enabled": true,
      "status": "pending",
      "embed_error": "string",
      "embedded_at": "2024-01-15T09:30:00Z",
      "scenario_count": 1,
      "embedding_model_version": "string",
      "overlaps": [
        {}
      ],
      "scenarios": [
        {
          "id": 1,
          "text": "string",
          "embedded": true
        }
      ]
    }
  ],
  "calibration": {
    "status": "string",
    "calibrated_at": "2024-01-15T09:30:00Z",
    "overall_recall": 1.1,
    "warnings": [
      {}
    ]
  }
}

Retrieve the team’s Signal settings, the built-in categories, the team’s custom categories with their example phrases, and calibration status.

Authentication

AuthorizationBearer

API key from https://app.resemble.ai/hub/api

Response

Categories, settings, and calibration

successboolean

settingsobjectOptional

built_in_categorieslist of objectsOptional

custom_categorieslist of objectsOptional

calibrationobjectOptional

Null until the team's categories have been calibrated.

Errors

403

Forbidden Error