VocalDocscontracts 1.65.0

Read the Provider registry

GET /v1/platform/providers

PropertyValue
Operationget_platform_providers
GroupPlatform
Scopeplatform:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; the registry is platform data.
Released in1.10.0
Phase 0 hostServed (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 platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

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

Responses

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

Fields of the 200 answer

The shape is ProviderRegistry.

FieldTypeRequiredDescription
entriesarray of ProviderRegistryEntryyes
object"platform_providers"yes
secondariesStageSecondariesyes
updated_atTimestamp or nullyes
updated_byActorRef or nullyes
versionintegeryes0 before the first replacement; the ETag.