VocalDocscontracts 1.65.0

List the models and voices of the Provider inventory

GET /v1/platform/inventory

PropertyValue
Operationlist_inventory
GroupPlatform
Scopeagents:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A catalog read; the inventory is platform data.
Released in1.12.0
Phase 0 hostServed (the hosted api pins 1.65.0)

The inventory items in Provider, kind and name order, with their enablement and list price. A reader who is not an operator never sees a disabled item or one a sync no longer lists; an operator sees them with include_disabled=true.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the agents:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/platform/inventory" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
providerqueryProviderIdnoOnly the items of this Provider.
kindqueryInventoryKindnoOnly models or only voices.
stagequeryProviderStagenoOnly the models of this stage.
languagequeryLanguageTagnoOnly the items that list this language; en also matches en-US.
qquerystringnoOnly the items whose name or id contains this text, ignoring case.
include_disabledquerybooleannoTrue also lists disabled items and items a sync no longer lists. Honoured for operators only and ignored for every other reader, who never sees them.

Responses

StatusContent typeShapeError codes
200application/jsonInventoryList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is InventoryList.

FieldTypeRequiredDescription
dataarray of ProviderInventoryItemyesThe inventory items of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes