Skip to main content

Class: AIGatewayProvidersClient

Defined in: src/ai-gateway/providers-client.ts:27

Client for AI Gateway provider operations (data plane).

Constructors

Constructor

new AIGatewayProvidersClient(opts): AIGatewayProvidersClient;

Defined in: src/ai-gateway/providers-client.ts:32

Parameters

ParameterType
optsAIGatewaySubClientOptions

Returns

AIGatewayProvidersClient

Methods

list()

list(opts): Promise<objectOutputType<{
object: ZodString;
total: ZodNumber;
has_more: ZodOptional<ZodBoolean>;
data: ZodArray<ZodObject<{
id: ZodString;
name: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
object: ZodOptional<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodString;
name: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
object: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodString;
name: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
object: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/providers-client.ts:51

List providers in a workspace.

Parameters

ParameterTypeDescription
optsAIGatewayWorkspaceScopedListOptionsMust include the workspace UUID.

Returns

Promise<objectOutputType<{ object: ZodString; total: ZodNumber; has_more: ZodOptional<ZodBoolean>; data: ZodArray<ZodObject<{ id: ZodString; name: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; object: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; name: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; object: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; name: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; object: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Providers bound into that workspace.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

const p = await gw.providers.list({ workspaceId: '16f7e90d-382a-4e78-b577-1b01eb5f8297' });
// p.data[0].slug => 'openai-calvin'

create()

create(body): Promise<objectOutputType<{
id: ZodString;
slug: ZodString;
object: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/providers-client.ts:90

Create a provider.

Parameters

ParameterTypeDescription
bodyGatewayProviderCreateRequestWorkspace UUID, upstream provider id, integration id, name, and slug.

Returns

Promise<objectOutputType<{ id: ZodString; slug: ZodString; object: ZodString; }, ZodTypeAny, "passthrough">>

The creation receipt.

Remarks

The response is a creation receipt{ id, slug, object } — not a GatewayProvider. Note it has no version_id, unlike the sibling receipts for configs.create and guardrails.create. Verified live 2026-07-28.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

const receipt = await gw.providers.create({
workspace_id: '16f7e90d-382a-4e78-b577-1b01eb5f8297',
ai_provider_id: 'de7d7d50-31cd-11ee-b93b-0e06f1aa7f7c',
integration_id: 'f6692544-3265-49be-9711-bbdcebc079e4',
name: 'openai-calvin',
slug: 'openai-calvin',
});
// receipt => { id: '...', slug: 'sdk-verify-delete-me-provider', object: 'provider' }

delete()

delete(providerId): Promise<void>;

Defined in: src/ai-gateway/providers-client.ts:124

Delete a provider.

Parameters

ParameterTypeDescription
providerIdstringProvider UUID.

Returns

Promise<void>

Nothing.

Remarks

This is a hard delete — unlike deployments.delete (which archives), the provider disappears from list entirely. Verified live 2026-07-28. No organisation_id query param is required, unlike deployments/integrations.

Example

import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();

await gw.providers.delete('f6692544-3265-49be-9711-bbdcebc079e4');
// the provider no longer appears in gw.providers.list()