Skip to main content

ProvidersClient

adaline.providers lists and inspects the LLM providers configured in your workspace.

Access

import { Adaline } from '@adaline/client';

const adaline = new Adaline();
const providers = adaline.providers; // ProvidersClient
The class is also exported directly:
import { ProvidersClient } from '@adaline/client';
Types from @adaline/api:
import type {
  GetProviderResponse,
  ListProvidersResponse,
} from '@adaline/api';

list()

List every provider configured in the workspace. Does not include model lists — use get() with includeModels: true for that.
list(): Promise<ListProvidersResponse>

Parameters

None.

Returns

Promise<ListProvidersResponse> with { data: Provider[] }. Each Provider has id, settingId, provider (provider name, e.g., "openai"), description, modelSettings, and timestamps.

Example

const { data } = await adaline.providers.list();

for (const provider of data) {
  console.log(provider.id, provider.provider);
}

get()

Fetch a single provider. Pass includeModels: true to also return the list of models available under this provider.
get(options: {
  providerId: string;
  includeModels?: boolean;
}): Promise<GetProviderResponse>

Parameters

NameTypeRequiredDescription
providerIdstringYesProvider identifier.
includeModelsbooleanNoWhen true, populate availableModels in the response.

Returns

Promise<GetProviderResponse> — the provider record plus (when requested) availableModels: Model[].

Example

const provider = await adaline.providers.get({
  providerId: 'provider_abc123',
  includeModels: true,
});

for (const model of provider.availableModels ?? []) {
  console.log(model.model, model.enabled);
}

See Also