Providers
14 methods on the Providers resource.
14 methods · 3 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";14 of 14
curateProviderModelgetProvidergetProviderModelStatusgetProviderModelStatusByProvidergetProviderUsagelistProviderModelslistProviderModelsByProviderlistProviderUsagelistProvidersprobeProviderAuthrefreshProviderModelsrefreshProviderModelsByProviderrefreshProviderUsagestreamProviderUsagesse
curateProviderModel
Curate one provider model through the live settings lifecycle
compozy.providers.curateProviderModel({ path, body }) → Promise<ProviderModelCurationResponse>
Options
- provider_idstringpathrequired
- CompozyOS provider id
Request bodyProviderModelCurationRequest
POST /api/model-catalog/providers/{provider_id}/models/curateapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.curateProviderModel({ path: { "provider_id": "provider_id" }, body: { /* request fields */ } });getProvider
Get one provider and declared auth status
compozy.providers.getProvider({ path }) → Promise<ProviderSummaryPayload>
Options
- provider_idstringpathrequired
- CompozyOS provider id
GET /api/providers/{provider_id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.getProvider({ path: { "provider_id": "provider_id" } });getProviderModelStatus
List provider model catalog source status across providers
compozy.providers.getProviderModelStatus() → Promise<ProviderModelStatusResponse>
GET /api/model-catalog/sources/statusapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.getProviderModelStatus();getProviderModelStatusByProvider
List provider model catalog source status for one provider
compozy.providers.getProviderModelStatusByProvider({ path }) → Promise<ProviderModelStatusResponse>
Options
- provider_idstringpathrequired
- CompozyOS provider id
GET /api/model-catalog/providers/{provider_id}/models/statusapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.getProviderModelStatusByProvider({ path: { "provider_id": "provider_id" } });getProviderUsage
Read cached provider usage (experimental)
compozy.providers.getProviderUsage({ path, query }) → Promise<ProviderUsageEnvelope>
Options
- provider_idstringpathrequired
- Canonical provider ID
- profilestringquery
- Profile name; defaults to the caller session profile or default
GET /api/provider-usage/providers/{provider_id}app tokens allowed
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.getProviderUsage({ path: { "provider_id": "provider_id" } });listProviderModels
List provider model catalog entries across providers
compozy.providers.listProviderModels({ query }) → Promise<ProviderModelListResponse>
Options
- provider_idstringquery
- Filter by CompozyOS provider id
- view"curated" | "all"query
- Catalog view; defaults to curated
- source_idstringquery
- Filter by catalog source id
- refreshbooleanquery
- Refresh sources before listing models
- include_stalebooleanquery
- Include stale source rows in the merged projection
GET /api/model-catalog/modelsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.listProviderModels();listProviderModelsByProvider
List provider model catalog entries for one provider
compozy.providers.listProviderModelsByProvider({ path, query }) → Promise<ProviderModelListResponse>
Options
- provider_idstringpathrequired
- CompozyOS provider id
- view"curated" | "all"query
- Catalog view; defaults to curated
- source_idstringquery
- Filter by catalog source id
- refreshbooleanquery
- Refresh sources before listing models
- include_stalebooleanquery
- Include stale source rows in the merged projection
GET /api/model-catalog/providers/{provider_id}/modelsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.listProviderModelsByProvider({ path: { "provider_id": "provider_id" } });listProviderUsage
Read cached provider usage (experimental)
compozy.providers.listProviderUsage({ query }) → Promise<ProviderUsageEnvelope>
Options
- profilestringquery
- Profile name; defaults to the caller session profile or default
GET /api/provider-usageapp tokens allowed
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.listProviderUsage();listProviders
List providers and declared auth status
compozy.providers.listProviders() → Promise<ProviderListResponse>
GET /api/providersapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.listProviders();probeProviderAuth
Run a non-interactive provider auth status probe
compozy.providers.probeProviderAuth({ path }) → Promise<ProviderAuthProbeResponse>
Options
- provider_idstringpathrequired
- CompozyOS provider id
POST /api/providers/{provider_id}/auth/probeapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.probeProviderAuth({ path: { "provider_id": "provider_id" } });Show all 14 methods
refreshProviderModels
Refresh provider model catalog sources across providers
compozy.providers.refreshProviderModels({ body }) → Promise<ProviderModelRefreshResponse>
Request bodyProviderModelRefreshRequest
POST /api/model-catalog/models/refreshapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.refreshProviderModels({ body: { /* request fields */ } });refreshProviderModelsByProvider
Refresh provider model catalog sources for one provider
compozy.providers.refreshProviderModelsByProvider({ path, body }) → Promise<ProviderModelRefreshResponse>
Options
- provider_idstringpathrequired
- CompozyOS provider id
Request bodyProviderModelRefreshRequest
POST /api/model-catalog/providers/{provider_id}/models/refreshapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.refreshProviderModelsByProvider({ path: { "provider_id": "provider_id" }, body: { /* request fields */ } });refreshProviderUsage
Refresh provider usage (experimental)
compozy.providers.refreshProviderUsage({ body }) → Promise<ProviderUsageEnvelope>
Request bodyProviderUsageRefreshRequest
POST /api/provider-usage/refreshapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.providers.refreshProviderUsage({ body: { /* request fields */ } });streamProviderUsage
Stream provider usage invalidations (experimental)
compozy.events("streamProviderUsage", { query }) → AsyncIterable<StreamEvent<SseFrame<"streamProviderUsage">>>
Options
- profilestringquery
- Profile name; defaults to the caller session profile or default
GET /api/provider-usage/streamapp tokens allowed
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();for await (const frame of compozy.events("streamProviderUsage", {})) { console.log(frame);}