Get Voice Facets

{
  "data": {
    "providers": [
      {
        "value": "elevenlabs",
        "count": 24,
        "label": "Eleven Labs"
      },
      {
        "value": "rime",
        "count": 15,
        "label": "Rime AI"
      },
      {
        "value": "google",
        "count": 30,
        "label": "Google Cloud"
      }
    ],
    "models": [
      {
        "value": "arcana",
        "count": 12,
        "label": "Arcana"
      },
      {
        "value": "sonic-2",
        "count": 18,
        "label": "Sonic 2"
      },
      {
        "value": "vocalise",
        "count": 9,
        "label": "Vocalise"
      }
    ],
    "languages": [
      {
        "value": "en-us",
        "count": 40,
        "label": null
      },
      {
        "value": "es-es",
        "count": 10,
        "label": null
      },
      {
        "value": "fr-fr",
        "count": 8,
        "label": null
      }
    ],
    "genders": [
      {
        "value": "male",
        "count": 28,
        "label": null
      },
      {
        "value": "female",
        "count": 35,
        "label": null
      },
      {
        "value": "neutral",
        "count": 5,
        "label": null
      }
    ],
    "ages": [
      {
        "value": "young",
        "count": 20,
        "label": null
      },
      {
        "value": "middle_aged",
        "count": 30,
        "label": null
      },
      {
        "value": "old",
        "count": 18,
        "label": null
      }
    ],
    "categories": [
      {
        "value": "news",
        "count": 22,
        "label": null
      },
      {
        "value": "narration",
        "count": 15,
        "label": null
      },
      {
        "value": "story",
        "count": 10,
        "label": null
      },
      {
        "value": "podcast",
        "count": 8,
        "label": null
      },
      {
        "value": "conversational",
        "count": 12,
        "label": null
      },
      {
        "value": "social_media",
        "count": 5,
        "label": null
      },
      {
        "value": "educational",
        "count": 18,
        "label": null
      },
      {
        "value": "business",
        "count": 20,
        "label": null
      }
    ],
    "accents": [
      {
        "value": "american",
        "count": 25,
        "label": null
      },
      {
        "value": "british",
        "count": 15,
        "label": null
      },
      {
        "value": "australian",
        "count": 8,
        "label": null
      },
      {
        "value": "indian",
        "count": 5,
        "label": null
      },
      {
        "value": "canadian",
        "count": 3,
        "label": null
      },
      {
        "value": "irish",
        "count": 0,
        "label": null
      },
      {
        "value": "african",
        "count": 0,
        "label": null
      },
      {
        "value": "european",
        "count": 7,
        "label": null
      },
      {
        "value": "east_asian",
        "count": 4,
        "label": null
      },
      {
        "value": "southeast_asian",
        "count": 2,
        "label": null
      },
      {
        "value": "latin_american",
        "count": 1,
        "label": null
      },
      {
        "value": "middle_eastern",
        "count": 0,
        "label": null
      },
      {
        "value": "slavic",
        "count": 0,
        "label": null
      },
      {
        "value": "spanish",
        "count": 6,
        "label": null
      },
      {
        "value": "french",
        "count": 5,
        "label": null
      },
      {
        "value": "german",
        "count": 3,
        "label": null
      },
      {
        "value": "italian",
        "count": 2,
        "label": null
      },
      {
        "value": "portuguese",
        "count": 1,
        "label": null
      },
      {
        "value": "japanese",
        "count": 4,
        "label": null
      },
      {
        "value": "korean",
        "count": 3,
        "label": null
      },
      {
        "value": "chinese",
        "count": 5,
        "label": null
      },
      {
        "value": "thai",
        "count": 0,
        "label": null
      },
      {
        "value": "vietnamese",
        "count": 0,
        "label": null
      },
      {
        "value": "other",
        "count": 0,
        "label": null
      }
    ]
  },
  "meta": {
    "request_id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}

Filter-bar options (chips) for the voice browser, one list per dimension.

Returns providers, models, languages (data-driven) plus genders, ages, categories, accents (fixed enums) as VoiceFacetItem[] so the FE builds the whole filter bar — with per-chip count badges — in a single request instead of hardcoding option lists (mirrors GET /dictionary/languages). Each item is {value, label, count}: value is passed straight back to GET /voices; label is the display name for providers/models and null elsewhere (the FE owns language + enum labels); count is the number of matching voices. For languages/models, count counts only voices that explicitly declare the value — “general-use” platform voices (no declared locales/models) that GET /voices matches against every language/model filter are not counted, so a chip’s count can be lower than the GET /voices result.

Accepts the SAME filters as GET /voices (tab scope source/favorites_only, plus provider/model/language/gender/age/category/accent/search). count is context-aware (faceted search): each dimension’s counts apply every OTHER active filter but exclude that dimension’s own selection — e.g. with provider=elevenlabs the language counts are scoped to ElevenLabs, while the provider chips still show every provider so the caller can switch.

Count-0 policy: data-driven dimensions omit count-0 values (only present ones, each a valid GET /voices filter — providers/models restricted to the enabled catalog, languages to the supported-locale allowlist, so a chip never 422s). Enum dimensions always return the full enum in natural order, count-0 included, for the FE to grey out.

Filter-bar options (chips) for the voice browser, one list per dimension. Returns `providers`, `models`, `languages` (data-driven) plus `genders`, `ages`, `categories`, `accents` (fixed enums) as `VoiceFacetItem[]` so the FE builds the whole filter bar — with per-chip count badges — in a single request instead of hardcoding option lists (mirrors `GET /dictionary/languages`). Each item is `{value, label, count}`: `value` is passed straight back to `GET /voices`; `label` is the display name for providers/models and `null` elsewhere (the FE owns language + enum labels); `count` is the number of matching voices. For `languages`/`models`, `count` counts only voices that explicitly declare the value — "general-use" platform voices (no declared locales/models) that `GET /voices` matches against every language/model filter are not counted, so a chip's count can be lower than the `GET /voices` result. Accepts the SAME filters as `GET /voices` (tab scope `source`/`favorites_only`, plus `provider`/`model`/`language`/`gender`/`age`/`category`/`accent`/`search`). `count` is context-aware (faceted search): each dimension's counts apply every OTHER active filter but exclude that dimension's own selection — e.g. with `provider=elevenlabs` the language counts are scoped to ElevenLabs, while the provider chips still show every provider so the caller can switch. Count-0 policy: data-driven dimensions omit count-0 values (only present ones, each a valid `GET /voices` filter — providers/models restricted to the enabled catalog, languages to the supported-locale allowlist, so a chip never 422s). Enum dimensions always return the full enum in natural order, count-0 included, for the FE to grey out.

Response

Successful Response

dataobject

Filter options for the voice browser, one VoiceFacetItem[] per chip.

Two families of dimension:

Data-driven — providers, models, languages: only values actually present in the scoped voices are returned (count is always ≥ 1; count-0 values are omitted). Every value is guaranteed to be a valid GET /voices filter (provider/model restricted to the enabled catalog, language to the supported-locale allowlist), so selecting one never yields a 422 or empty page. Sorted count DESC, then value ASC.
Enum — genders, ages, categories, accents: the FULL fixed enum is always returned in natural enum order, including count-0 values (the FE greys those out). label is None (the FE owns enum labels).

count is context-aware (faceted search): each dimension’s counts apply every OTHER active filter but exclude that dimension’s own selection, so a chip’s number reflects “results if I also pick this” without the dimension suppressing its own alternatives.

metaobject

Filter-bar options (chips) for the voice browser, one list per dimension.

Get Voice Facets

Authentication

Headers

Query parameters

Response

Errors

$	curl https://api.onepin.ai/api/v1/voices/facets \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"