List the Provider descriptors
GET /v1/providers
Property Value Operation list_providersGroup Providers and credentials Scope agents:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A catalog read; the descriptors are platform data. Released in 1.6.0 Phase 0 host Served (the hosted api pins 1.65.0)
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 Node.js Python
curl "$VOCAL_API/v1/providers" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/providers`, {
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/providers",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description limitquery integer no The page size, 1 to 100. cursorquery string no The opaque next_cursor of the previous page; it binds the filters it was issued under.
Responses
Fields of the 200 answer
The shape is ProviderList .
Field Type Required Description dataarray of ProviderListItem yes The Provider descriptors of this page, newest first. has_moreboolean yes True when a further page exists. next_cursorstring or null yes The cursor of the next page, or null on the last page. object"list"yes