ProviderListItem
A Provider descriptor with the Provider registry applied (1.10.0): an Agent may name the catalog models and, from 1.12.0, the inventory models, less disabled_models, plus added_models, while enabled is true.
An object with 25 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
added_models | array of AddedModel | no | Models an Agent may name besides the catalog models. Added in 1.10.0: the api always sends it, and a reader treats its absence as none. |
baa_available | BaaAvailability | yes | |
credential | CredentialSummary or null | no | The active platform credential of the Provider, masked, or null when none is entered and the worker uses its environment key; from 1.28.0 the newest active member of the Provider's key pool. Sent to operator readers only; absent for every other reader. |
credential_modes | array of CredentialMode | yes | Empty for Providers that need no credential. From 1.28.0 a Provider that lists byok accepts an Organization's own key (/v1/provider-credentials), and every descriptor of one Provider agrees on it. |
data_regions | array of string | yes | One entry per region a request may be processed in; unknown when not verified; empty for in-process Providers, which send nothing off the worker. |
decision | DecisionDescriptor | no | decision (1.58.0): the question types and bounds the Provider answers. Omitted for every other stage. |
deployment | ProviderDeployment | yes | |
descriptor_version | integer | yes | Bumped on any change to this descriptor. |
disabled_models | array of string | no | Catalog models, and from 1.12.0 inventory models, of this Provider and stage that no Agent may name. Added in 1.10.0: the api always sends it, and a reader treats its absence as none. |
embedding_models | array of EmbeddingModelDescriptor | no | embeddings (1.53.0): one entry per id of models, with the space it produces. Omitted for every other stage. |
enabled | boolean | no | False disables the Provider on this stage: publish refuses an Agent that names it, and admission drops it from every chain. Added in 1.10.0: the api always sends it, and a reader treats its absence as true. |
implementation | ProviderImplementation | yes | |
inventory | ProviderInventorySummary or null | no | The Provider inventory counts of this descriptor, or null when the inventory holds no item of the Provider and stage. Added in 1.12.0: the api always sends it, and a reader treats its absence as null. |
languages | array of LanguageTag | yes | Languages declared for this stage; empty when the stage does not depend on language. |
lifecycle | ProviderLifecycle | yes | |
livekit_plugin | LiveKitPlugin or null | yes | |
model_family | ModelFamily | no | llm (1.56.0): the family of the descriptor's models, which selects a Prompt template's variant; the variant default serves a descriptor without one. Omitted for every other stage and for a mock. |
models | array of string | yes | The model ids an Agent may name for this stage; empty for stages an Agent does not configure and for reserved descriptors. |
pricing_unit | PricingUnit | yes | |
provider | ProviderId | yes | |
source | DescriptorSource | yes | |
stage | ProviderStage | yes | |
streaming | boolean | no | stt: recognizes a live audio stream; llm: streams tokens; tts: accepts streamed text. Omitted when not verified. |
tool_calling | boolean | no | llm: supports tool calls. Omitted when not verified. |
word_timestamps | boolean | no | stt and tts: returns word timings. Omitted when not verified. |