List the models and voices of the Provider inventory
GET /v1/platform/inventory
| Property | Value |
|---|---|
| Operation | list_inventory |
| Group | Platform |
| Scope | agents:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A catalog read; the inventory is platform data. |
| Released in | 1.12.0 |
| Phase 0 host | Served (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"const response = await fetch(`${process.env.VOCAL_API}/v1/platform/inventory`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/platform/inventory",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
provider | query | ProviderId | no | Only the items of this Provider. |
kind | query | InventoryKind | no | Only models or only voices. |
stage | query | ProviderStage | no | Only the models of this stage. |
language | query | LanguageTag | no | Only the items that list this language; en also matches en-US. |
q | query | string | no | Only the items whose name or id contains this text, ignoring case. |
include_disabled | query | boolean | no | True 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
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | InventoryList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is InventoryList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of ProviderInventoryItem | yes | The inventory items of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |