Skip to main content

Class: AIGatewayIntegrationsClient

Defined in: src/ai-gateway/integrations-client.ts:96

Client for AI Gateway organisation-level integrations (admin plane).

Constructors​

Constructor​

new AIGatewayIntegrationsClient(opts): AIGatewayIntegrationsClient;

Defined in: src/ai-gateway/integrations-client.ts:101

Parameters​

ParameterType
optsAIGatewaySubClientOptions

Returns​

AIGatewayIntegrationsClient

Methods​

deleteModels()​

deleteModels(integrationId, slugs): Promise<objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
success: ZodOptional<ZodBoolean>;
data: ZodOptional<ZodUnion<[ZodObject<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:111

Remove explicitly named custom models from one integration. Verified on an owned integration and custom model, 2026-09-06. Base models cannot be deleted.

Parameters​

ParameterType
integrationIdstring
slugsstring[]

Returns​

Promise<objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; success: ZodOptional<ZodBoolean>; data: ZodOptional<ZodUnion<[ZodObject<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>; }, ZodTypeAny, "passthrough">>

Example​

`await gw.integrations.deleteModels('integration-slug', ['model-slug']);`

catalog()​

catalog(): Promise<objectOutputType<{
success: ZodOptional<ZodBoolean>;
data: ZodArray<ZodObject<{
id: ZodString;
slug: ZodString;
name: ZodString;
status: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
last_updated_at: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodString;
slug: ZodString;
name: ZodString;
status: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
last_updated_at: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodString;
slug: ZodString;
name: ZodString;
status: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
last_updated_at: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:147

List the static provider catalog: every provider family an integration can bind to. The catalog has no configuration-field metadata; it maps slugs such as open-ai or x-ai to the ai_provider_id UUID a create needs.

Returns​

Promise<objectOutputType<{ success: ZodOptional<ZodBoolean>; data: ZodArray<ZodObject<{ id: ZodString; slug: ZodString; name: ZodString; status: ZodString; description: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; last_updated_at: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; slug: ZodString; name: ZodString; status: ZodString; description: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; last_updated_at: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; slug: ZodString; name: ZodString; status: ZodString; description: ZodOptional<ZodNullable<ZodString>>; created_at: ZodOptional<ZodNullable<ZodString>>; last_updated_at: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

The catalog envelope (success, data[]).

Example​

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

const catalog = await gw.integrations.catalog();
// catalog.data.find((p) => p.slug === 'x-ai')?.id => '0a9635da-bd84-11ef-9c04-1235d6b0b075'

resolveProviderId()​

resolveProviderId(providerRef): Promise<string>;

Defined in: src/ai-gateway/integrations-client.ts:174

Turn a provider slug (open-ai, x-ai) or UUID into the ai_provider_id a create needs. A UUID is returned unchanged without a request; a slug is matched case-insensitively against catalog.

Parameters​

ParameterTypeDescription
providerRefstringCatalog slug or provider UUID.

Returns​

Promise<string>

The provider UUID.

Throws​

When the slug is not in the catalog (the message lists close matches).

Example​

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

const id = await gw.integrations.resolveProviderId('x-ai');
// id => '0a9635da-bd84-11ef-9c04-1235d6b0b075'

list()​

list(): Promise<objectOutputType<{
object: ZodString;
total: ZodNumber;
success: ZodOptional<ZodBoolean>;
has_more: ZodOptional<ZodBoolean>;
data: ZodArray<ZodObject<{
id: ZodString;
organisation_id: ZodOptional<ZodString>;
name: ZodString;
owner_id: ZodString;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
slug: ZodString;
tags: ZodNullable<ZodUnknown>;
description: ZodNullable<ZodString>;
workspaces_count: ZodOptional<ZodNumber>;
type: ZodOptional<ZodString>;
workspace_id: ZodNullable<ZodString>;
ai_provider_id: ZodString;
object: ZodString;
masked_key: ZodOptional<ZodNullable<ZodString>>;
configurations: ZodOptional<ZodNullable<ZodUnion<[ZodType<..., ..., ...>, ZodString]>>>;
global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<{
enabled: ...;
rate_limits: ...;
usage_limits: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>>;
allow_all_models: ZodOptional<ZodBoolean>;
workspace_count: ZodOptional<ZodNumber>;
secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<{
[key: ...]: ...;
target_field: ...;
secret_reference_id: ...;
secret_key?: ...;
value_format?: ...;
}, ZodTypeDef, {
[key: ...]: ...;
target_field: ...;
secret_reference_id: ...;
secret_key?: ...;
value_format?: ...;
}>, "many">>>;
pricing_adjustments: ZodOptional<ZodNullable<ZodType<
| {
multiplier?: ...;
}
| null, ZodTypeDef,
| {
multiplier?: ...;
}
| null>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodString;
organisation_id: ZodOptional<ZodString>;
name: ZodString;
owner_id: ZodString;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
slug: ZodString;
tags: ZodNullable<ZodUnknown>;
description: ZodNullable<ZodString>;
workspaces_count: ZodOptional<ZodNumber>;
type: ZodOptional<ZodString>;
workspace_id: ZodNullable<ZodString>;
ai_provider_id: ZodString;
object: ZodString;
masked_key: ZodOptional<ZodNullable<ZodString>>;
configurations: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
allow_all_models: ZodOptional<ZodBoolean>;
workspace_count: ZodOptional<ZodNumber>;
secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<..., ..., ...>, "many">>>;
pricing_adjustments: ZodOptional<ZodNullable<ZodType<... | ..., ZodTypeDef, ... | ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodString;
organisation_id: ZodOptional<ZodString>;
name: ZodString;
owner_id: ZodString;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
slug: ZodString;
tags: ZodNullable<ZodUnknown>;
description: ZodNullable<ZodString>;
workspaces_count: ZodOptional<ZodNumber>;
type: ZodOptional<ZodString>;
workspace_id: ZodNullable<ZodString>;
ai_provider_id: ZodString;
object: ZodString;
masked_key: ZodOptional<ZodNullable<ZodString>>;
configurations: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
allow_all_models: ZodOptional<ZodBoolean>;
workspace_count: ZodOptional<ZodNumber>;
secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<..., ..., ...>, "many">>>;
pricing_adjustments: ZodOptional<ZodNullable<ZodType<... | ..., ZodTypeDef, ... | ...>>>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:210

List organisation integrations.

Returns​

Promise<objectOutputType<{ object: ZodString; total: ZodNumber; success: ZodOptional<ZodBoolean>; has_more: ZodOptional<ZodBoolean>; data: ZodArray<ZodObject<{ id: ZodString; organisation_id: ZodOptional<ZodString>; name: ZodString; owner_id: ZodString; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; slug: ZodString; tags: ZodNullable<ZodUnknown>; description: ZodNullable<ZodString>; workspaces_count: ZodOptional<ZodNumber>; type: ZodOptional<ZodString>; workspace_id: ZodNullable<ZodString>; ai_provider_id: ZodString; object: ZodString; masked_key: ZodOptional<ZodNullable<ZodString>>; configurations: ZodOptional<ZodNullable<ZodUnion<[ZodType<..., ..., ...>, ZodString]>>>; global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<{ enabled: ...; rate_limits: ...; usage_limits: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>>; allow_all_models: ZodOptional<ZodBoolean>; workspace_count: ZodOptional<ZodNumber>; secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<{ [key: ...]: ...; target_field: ...; secret_reference_id: ...; secret_key?: ...; value_format?: ...; }, ZodTypeDef, { [key: ...]: ...; target_field: ...; secret_reference_id: ...; secret_key?: ...; value_format?: ...; }>, "many">>>; pricing_adjustments: ZodOptional<ZodNullable<ZodType< | { multiplier?: ...; } | null, ZodTypeDef, | { multiplier?: ...; } | null>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; organisation_id: ZodOptional<ZodString>; name: ZodString; owner_id: ZodString; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; slug: ZodString; tags: ZodNullable<ZodUnknown>; description: ZodNullable<ZodString>; workspaces_count: ZodOptional<ZodNumber>; type: ZodOptional<ZodString>; workspace_id: ZodNullable<ZodString>; ai_provider_id: ZodString; object: ZodString; masked_key: ZodOptional<ZodNullable<ZodString>>; configurations: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>; allow_all_models: ZodOptional<ZodBoolean>; workspace_count: ZodOptional<ZodNumber>; secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<..., ..., ...>, "many">>>; pricing_adjustments: ZodOptional<ZodNullable<ZodType<... | ..., ZodTypeDef, ... | ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; organisation_id: ZodOptional<ZodString>; name: ZodString; owner_id: ZodString; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; slug: ZodString; tags: ZodNullable<ZodUnknown>; description: ZodNullable<ZodString>; workspaces_count: ZodOptional<ZodNumber>; type: ZodOptional<ZodString>; workspace_id: ZodNullable<ZodString>; ai_provider_id: ZodString; object: ZodString; masked_key: ZodOptional<ZodNullable<ZodString>>; configurations: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>; global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>; allow_all_models: ZodOptional<ZodBoolean>; workspace_count: ZodOptional<ZodNumber>; secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<..., ..., ...>, "many">>>; pricing_adjustments: ZodOptional<ZodNullable<ZodType<... | ..., ZodTypeDef, ... | ...>>>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

All provider integrations defined on the organisation.

Example​

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

const ints = await gw.integrations.list();
// ints.data[0] => { name: 'openai-calvin', slug: 'openai-calvin', ... }

get()​

get(integrationId): Promise<objectOutputType<{
id: ZodString;
organisation_id: ZodOptional<ZodString>;
name: ZodString;
owner_id: ZodString;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
slug: ZodString;
tags: ZodNullable<ZodUnknown>;
description: ZodNullable<ZodString>;
workspaces_count: ZodOptional<ZodNumber>;
type: ZodOptional<ZodString>;
workspace_id: ZodNullable<ZodString>;
ai_provider_id: ZodString;
object: ZodString;
masked_key: ZodOptional<ZodNullable<ZodString>>;
configurations: ZodOptional<ZodNullable<ZodUnion<[ZodType<
| {
[key: string]: unknown;
openai_organization?: ... | ...;
openai_project?: ... | ...;
}
| {
[key: string]: unknown;
azure_auth_mode: string;
azure_resource_name: string;
azure_deployment_config: ...[];
azure_entra_tenant_id?: ... | ...;
azure_entra_client_id?: ... | ...;
azure_entra_client_secret?: ... | ...;
azure_managed_client_id?: ... | ...;
}
| {
[key: string]: unknown;
aws_auth_type: string;
aws_region: string;
aws_access_key_id?: ... | ...;
aws_secret_access_key?: ... | ...;
aws_role_arn?: ... | ...;
aws_external_id?: ... | ... | ...;
}
| {
[key: string]: unknown;
vertex_auth_type: string;
vertex_region: string;
vertex_project_id?: ... | ...;
vertex_service_account_json?: ... | ...;
}
| {
[key: string]: unknown;
azure_auth_mode: string;
azure_foundry_url: string;
azure_api_version?: ... | ...;
azure_deployment_name?: ... | ...;
azure_entra_tenant_id?: ... | ...;
azure_entra_client_id?: ... | ...;
azure_entra_client_secret?: ... | ...;
azure_managed_client_id?: ... | ...;
}
| {
[key: string]: unknown;
workers_ai_account_id: string;
}
| {
[key: ...]: ...;
aws_auth_type: ...;
aws_region: ...;
aws_access_key_id?: ...;
aws_secret_access_key?: ...;
aws_role_arn?: ...;
aws_external_id?: ...;
} & {
[key: ...]: ...;
amzn_sagemaker_custom_attributes?: ...;
amzn_sagemaker_target_model?: ...;
amzn_sagemaker_target_variant?: ...;
amzn_sagemaker_target_container_hostname?: ...;
amzn_sagemaker_inference_id?: ...;
amzn_sagemaker_enable_explanations?: ...;
amzn_sagemaker_inference_component?: ...;
amzn_sagemaker_session_id?: ...;
amzn_sagemaker_model_name?: ...;
}
| {
[key: string]: unknown;
huggingface_base_url?: ... | ...;
}
| {
[key: string]: unknown;
snowflake_account: string;
}
| {
[key: string]: unknown;
provider_auth_type?: ... | ...;
custom_host?: ... | ...;
custom_headers?: ... | ...;
}, ZodTypeDef,
| {
[key: string]: unknown;
openai_organization?: ... | ...;
openai_project?: ... | ...;
}
| {
[key: string]: unknown;
azure_auth_mode: string;
azure_resource_name: string;
azure_deployment_config: ...[];
azure_entra_tenant_id?: ... | ...;
azure_entra_client_id?: ... | ...;
azure_entra_client_secret?: ... | ...;
azure_managed_client_id?: ... | ...;
}
| {
[key: string]: unknown;
aws_auth_type: string;
aws_region: string;
aws_access_key_id?: ... | ...;
aws_secret_access_key?: ... | ...;
aws_role_arn?: ... | ...;
aws_external_id?: ... | ... | ...;
}
| {
[key: string]: unknown;
vertex_auth_type: string;
vertex_region: string;
vertex_project_id?: ... | ...;
vertex_service_account_json?: ... | ...;
}
| {
[key: string]: unknown;
azure_auth_mode: string;
azure_foundry_url: string;
azure_api_version?: ... | ...;
azure_deployment_name?: ... | ...;
azure_entra_tenant_id?: ... | ...;
azure_entra_client_id?: ... | ...;
azure_entra_client_secret?: ... | ...;
azure_managed_client_id?: ... | ...;
}
| {
[key: string]: unknown;
workers_ai_account_id: string;
}
| {
[key: ...]: ...;
aws_auth_type: ...;
aws_region: ...;
aws_access_key_id?: ...;
aws_secret_access_key?: ...;
aws_role_arn?: ...;
aws_external_id?: ...;
} & {
[key: ...]: ...;
amzn_sagemaker_custom_attributes?: ...;
amzn_sagemaker_target_model?: ...;
amzn_sagemaker_target_variant?: ...;
amzn_sagemaker_target_container_hostname?: ...;
amzn_sagemaker_inference_id?: ...;
amzn_sagemaker_enable_explanations?: ...;
amzn_sagemaker_inference_component?: ...;
amzn_sagemaker_session_id?: ...;
amzn_sagemaker_model_name?: ...;
}
| {
[key: string]: unknown;
huggingface_base_url?: ... | ...;
}
| {
[key: string]: unknown;
snowflake_account: string;
}
| {
[key: string]: unknown;
provider_auth_type?: ... | ...;
custom_host?: ... | ...;
custom_headers?: ... | ...;
}>, ZodString]>>>;
global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<{
enabled: ZodBoolean;
rate_limits: ZodOptional<ZodNullable<ZodUnion<...>>>;
usage_limits: ZodOptional<ZodNullable<ZodUnion<...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
enabled: ZodBoolean;
rate_limits: ZodOptional<ZodNullable<...>>;
usage_limits: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
enabled: ZodBoolean;
rate_limits: ZodOptional<ZodNullable<...>>;
usage_limits: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>>>>;
allow_all_models: ZodOptional<ZodBoolean>;
workspace_count: ZodOptional<ZodNumber>;
secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<{
[key: string]: unknown;
target_field: string;
secret_reference_id: string;
secret_key?: string | null;
value_format?: string | null;
}, ZodTypeDef, {
[key: string]: unknown;
target_field: string;
secret_reference_id: string;
secret_key?: string | null;
value_format?: string | null;
}>, "many">>>;
pricing_adjustments: ZodOptional<ZodNullable<ZodType<
| {
multiplier?: {
default?: ... | ... | ...;
request_token?: ... | ... | ...;
response_token?: ... | ... | ...;
cache_read_input_token?: ... | ... | ...;
cache_write_input_token?: ... | ... | ...;
cache_read_audio_input_token?: ... | ... | ...;
request_audio_token?: ... | ... | ...;
response_audio_token?: ... | ... | ...;
reasoning_token?: ... | ... | ...;
prediction_accepted_token?: ... | ... | ...;
prediction_rejected_token?: ... | ... | ...;
request_image_token?: ... | ... | ...;
response_image_token?: ... | ... | ...;
request_text_token?: ... | ... | ...;
response_text_token?: ... | ... | ...;
cache_read_image_input_token?: ... | ... | ...;
cache_read_text_input_token?: ... | ... | ...;
cache_write_text_input_token?: ... | ... | ...;
cache_write_image_input_token?: ... | ... | ...;
image?: ... | ... | ...;
additional_units?: ... | ... | ...;
};
}
| null, ZodTypeDef,
| {
multiplier?: {
default?: ... | ... | ...;
request_token?: ... | ... | ...;
response_token?: ... | ... | ...;
cache_read_input_token?: ... | ... | ...;
cache_write_input_token?: ... | ... | ...;
cache_read_audio_input_token?: ... | ... | ...;
request_audio_token?: ... | ... | ...;
response_audio_token?: ... | ... | ...;
reasoning_token?: ... | ... | ...;
prediction_accepted_token?: ... | ... | ...;
prediction_rejected_token?: ... | ... | ...;
request_image_token?: ... | ... | ...;
response_image_token?: ... | ... | ...;
request_text_token?: ... | ... | ...;
response_text_token?: ... | ... | ...;
cache_read_image_input_token?: ... | ... | ...;
cache_read_text_input_token?: ... | ... | ...;
cache_write_text_input_token?: ... | ... | ...;
cache_write_image_input_token?: ... | ... | ...;
image?: ... | ... | ...;
additional_units?: ... | ... | ...;
};
}
| null>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:234

Fetch one integration.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.

Returns​

Promise<objectOutputType<{ id: ZodString; organisation_id: ZodOptional<ZodString>; name: ZodString; owner_id: ZodString; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; slug: ZodString; tags: ZodNullable<ZodUnknown>; description: ZodNullable<ZodString>; workspaces_count: ZodOptional<ZodNumber>; type: ZodOptional<ZodString>; workspace_id: ZodNullable<ZodString>; ai_provider_id: ZodString; object: ZodString; masked_key: ZodOptional<ZodNullable<ZodString>>; configurations: ZodOptional<ZodNullable<ZodUnion<[ZodType< | { [key: string]: unknown; openai_organization?: ... | ...; openai_project?: ... | ...; } | { [key: string]: unknown; azure_auth_mode: string; azure_resource_name: string; azure_deployment_config: ...[]; azure_entra_tenant_id?: ... | ...; azure_entra_client_id?: ... | ...; azure_entra_client_secret?: ... | ...; azure_managed_client_id?: ... | ...; } | { [key: string]: unknown; aws_auth_type: string; aws_region: string; aws_access_key_id?: ... | ...; aws_secret_access_key?: ... | ...; aws_role_arn?: ... | ...; aws_external_id?: ... | ... | ...; } | { [key: string]: unknown; vertex_auth_type: string; vertex_region: string; vertex_project_id?: ... | ...; vertex_service_account_json?: ... | ...; } | { [key: string]: unknown; azure_auth_mode: string; azure_foundry_url: string; azure_api_version?: ... | ...; azure_deployment_name?: ... | ...; azure_entra_tenant_id?: ... | ...; azure_entra_client_id?: ... | ...; azure_entra_client_secret?: ... | ...; azure_managed_client_id?: ... | ...; } | { [key: string]: unknown; workers_ai_account_id: string; } | { [key: ...]: ...; aws_auth_type: ...; aws_region: ...; aws_access_key_id?: ...; aws_secret_access_key?: ...; aws_role_arn?: ...; aws_external_id?: ...; } & { [key: ...]: ...; amzn_sagemaker_custom_attributes?: ...; amzn_sagemaker_target_model?: ...; amzn_sagemaker_target_variant?: ...; amzn_sagemaker_target_container_hostname?: ...; amzn_sagemaker_inference_id?: ...; amzn_sagemaker_enable_explanations?: ...; amzn_sagemaker_inference_component?: ...; amzn_sagemaker_session_id?: ...; amzn_sagemaker_model_name?: ...; } | { [key: string]: unknown; huggingface_base_url?: ... | ...; } | { [key: string]: unknown; snowflake_account: string; } | { [key: string]: unknown; provider_auth_type?: ... | ...; custom_host?: ... | ...; custom_headers?: ... | ...; }, ZodTypeDef, | { [key: string]: unknown; openai_organization?: ... | ...; openai_project?: ... | ...; } | { [key: string]: unknown; azure_auth_mode: string; azure_resource_name: string; azure_deployment_config: ...[]; azure_entra_tenant_id?: ... | ...; azure_entra_client_id?: ... | ...; azure_entra_client_secret?: ... | ...; azure_managed_client_id?: ... | ...; } | { [key: string]: unknown; aws_auth_type: string; aws_region: string; aws_access_key_id?: ... | ...; aws_secret_access_key?: ... | ...; aws_role_arn?: ... | ...; aws_external_id?: ... | ... | ...; } | { [key: string]: unknown; vertex_auth_type: string; vertex_region: string; vertex_project_id?: ... | ...; vertex_service_account_json?: ... | ...; } | { [key: string]: unknown; azure_auth_mode: string; azure_foundry_url: string; azure_api_version?: ... | ...; azure_deployment_name?: ... | ...; azure_entra_tenant_id?: ... | ...; azure_entra_client_id?: ... | ...; azure_entra_client_secret?: ... | ...; azure_managed_client_id?: ... | ...; } | { [key: string]: unknown; workers_ai_account_id: string; } | { [key: ...]: ...; aws_auth_type: ...; aws_region: ...; aws_access_key_id?: ...; aws_secret_access_key?: ...; aws_role_arn?: ...; aws_external_id?: ...; } & { [key: ...]: ...; amzn_sagemaker_custom_attributes?: ...; amzn_sagemaker_target_model?: ...; amzn_sagemaker_target_variant?: ...; amzn_sagemaker_target_container_hostname?: ...; amzn_sagemaker_inference_id?: ...; amzn_sagemaker_enable_explanations?: ...; amzn_sagemaker_inference_component?: ...; amzn_sagemaker_session_id?: ...; amzn_sagemaker_model_name?: ...; } | { [key: string]: unknown; huggingface_base_url?: ... | ...; } | { [key: string]: unknown; snowflake_account: string; } | { [key: string]: unknown; provider_auth_type?: ... | ...; custom_host?: ... | ...; custom_headers?: ... | ...; }>, ZodString]>>>; global_workspace_access_settings: ZodOptional<ZodNullable<ZodLazy<ZodObject<{ enabled: ZodBoolean; rate_limits: ZodOptional<ZodNullable<ZodUnion<...>>>; usage_limits: ZodOptional<ZodNullable<ZodUnion<...>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ enabled: ZodBoolean; rate_limits: ZodOptional<ZodNullable<...>>; usage_limits: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ enabled: ZodBoolean; rate_limits: ZodOptional<ZodNullable<...>>; usage_limits: ZodOptional<ZodNullable<...>>; }, ZodTypeAny, "passthrough">>>>>; allow_all_models: ZodOptional<ZodBoolean>; workspace_count: ZodOptional<ZodNumber>; secret_mappings: ZodOptional<ZodNullable<ZodArray<ZodType<{ [key: string]: unknown; target_field: string; secret_reference_id: string; secret_key?: string | null; value_format?: string | null; }, ZodTypeDef, { [key: string]: unknown; target_field: string; secret_reference_id: string; secret_key?: string | null; value_format?: string | null; }>, "many">>>; pricing_adjustments: ZodOptional<ZodNullable<ZodType< | { multiplier?: { default?: ... | ... | ...; request_token?: ... | ... | ...; response_token?: ... | ... | ...; cache_read_input_token?: ... | ... | ...; cache_write_input_token?: ... | ... | ...; cache_read_audio_input_token?: ... | ... | ...; request_audio_token?: ... | ... | ...; response_audio_token?: ... | ... | ...; reasoning_token?: ... | ... | ...; prediction_accepted_token?: ... | ... | ...; prediction_rejected_token?: ... | ... | ...; request_image_token?: ... | ... | ...; response_image_token?: ... | ... | ...; request_text_token?: ... | ... | ...; response_text_token?: ... | ... | ...; cache_read_image_input_token?: ... | ... | ...; cache_read_text_input_token?: ... | ... | ...; cache_write_text_input_token?: ... | ... | ...; cache_write_image_input_token?: ... | ... | ...; image?: ... | ... | ...; additional_units?: ... | ... | ...; }; } | null, ZodTypeDef, | { multiplier?: { default?: ... | ... | ...; request_token?: ... | ... | ...; response_token?: ... | ... | ...; cache_read_input_token?: ... | ... | ...; cache_write_input_token?: ... | ... | ...; cache_read_audio_input_token?: ... | ... | ...; request_audio_token?: ... | ... | ...; response_audio_token?: ... | ... | ...; reasoning_token?: ... | ... | ...; prediction_accepted_token?: ... | ... | ...; prediction_rejected_token?: ... | ... | ...; request_image_token?: ... | ... | ...; response_image_token?: ... | ... | ...; request_text_token?: ... | ... | ...; response_text_token?: ... | ... | ...; cache_read_image_input_token?: ... | ... | ...; cache_read_text_input_token?: ... | ... | ...; cache_write_text_input_token?: ... | ... | ...; cache_write_image_input_token?: ... | ... | ...; image?: ... | ... | ...; additional_units?: ... | ... | ...; }; } | null>>>; }, ZodTypeAny, "passthrough">>

The integration record.

Example​

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

const i = await gw.integrations.get('f6692544-3265-49be-9711-bbdcebc079e4');
// i.name => 'openai-calvin'

create()​

create(body): Promise<objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
success: ZodOptional<ZodBoolean>;
data: ZodOptional<ZodUnion<[ZodObject<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:269

Create an integration.

Parameters​

ParameterTypeDescription
body{ organisation_id: string; workspace_id?: string; ai_provider_id: string; name: string; slug: string; description?: string; configurations?: ({ [key: string]: unknown; openai_organization?: string | undefined; openai_project?: string | undefined; } | { [key: string]: unknown; azure_auth_mode: string; azure_resource_name: string; azure_deployment_config: { ...; }[]; azure_entra_tenant_id?: string | undefined; azure_entra_client_id?: string | undefined; az...; key?: string; secret_mappings?: { target_field: string; secret_reference_id: string; secret_key?: string | null; value_format?: "string" | "json" | null; }[]; create_default_provider?: boolean; default_provider_slug?: string; pricing_adjustments?: | { multiplier?: { default?: number | null; request_token?: number | null; response_token?: number | null; cache_read_input_token?: number | null; cache_write_input_token?: number | null; cache_read_audio_input_token?: number | null; request_audio_token?: number | null; response_audio_token?: number | null; reasoning_token?: number | null; prediction_accepted_token?: number | null; prediction_rejected_token?: number | null; request_image_token?: number | null; response_image_token?: number | null; request_text_token?: number | null; response_text_token?: number | null; cache_read_image_input_token?: number | null; cache_read_text_input_token?: number | null; cache_write_text_input_token?: number | null; cache_write_image_input_token?: number | null; image?: | { default?: number | null; } | null; additional_units?: | { [key: string]: number | null; } | null; }; } | null; }Provider id, name, slug, and provider-specific configuration.
body.organisation_idstring-
body.workspace_id?stringOptional upstream workspace scope; verify hosted tenant support before relying on it.
body.ai_provider_idstring-
body.namestring-
body.slugstring-
body.description?string-
body.configurations?({ [key: string]: unknown; openai_organization?: string | undefined; openai_project?: string | undefined; } | { [key: string]: unknown; azure_auth_mode: string; azure_resource_name: string; azure_deployment_config: { ...; }[]; azure_entra_tenant_id?: string | undefined; azure_entra_client_id?: string | undefined; az...-
body.key?string-
body.secret_mappings?{ target_field: string; secret_reference_id: string; secret_key?: string | null; value_format?: "string" | "json" | null; }[]-
body.create_default_provider?boolean-
body.default_provider_slug?string-
body.pricing_adjustments?| { multiplier?: { default?: number | null; request_token?: number | null; response_token?: number | null; cache_read_input_token?: number | null; cache_write_input_token?: number | null; cache_read_audio_input_token?: number | null; request_audio_token?: number | null; response_audio_token?: number | null; reasoning_token?: number | null; prediction_accepted_token?: number | null; prediction_rejected_token?: number | null; request_image_token?: number | null; response_image_token?: number | null; request_text_token?: number | null; response_text_token?: number | null; cache_read_image_input_token?: number | null; cache_read_text_input_token?: number | null; cache_write_text_input_token?: number | null; cache_write_image_input_token?: number | null; image?: | { default?: number | null; } | null; additional_units?: | { [key: string]: number | null; } | null; }; } | null-

Returns​

Promise<objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; success: ZodOptional<ZodBoolean>; data: ZodOptional<ZodUnion<[ZodObject<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>; }, ZodTypeAny, "passthrough">>

The raw create response. Shape unverified against a live tenant — see the PRD.

Remarks​

body.key (the provider API key) is a live secret. SDK debug logs replace known credential fields with [REDACTED], but callers must still avoid logging the input object.

Example​

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

await gw.integrations.create({
organisation_id: '1852583913',
ai_provider_id: 'de7d7d50-31cd-11ee-b93b-0e06f1aa7f7c',
name: 'openai-prod',
slug: 'openai-prod',
key: process.env.OPENAI_API_KEY,
});

update()​

update(integrationId, body): Promise<objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
success: ZodOptional<ZodBoolean>;
data: ZodOptional<ZodUnion<[ZodObject<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:300

Update an integration.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.
body{ [key: string]: any; }One or more fields to update.

Returns​

Promise<objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; success: ZodOptional<ZodBoolean>; data: ZodOptional<ZodUnion<[ZodObject<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>; }, ZodTypeAny, "passthrough">>

The raw update response. Shape unverified against a live tenant — see the PRD.

Example​

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

await gw.integrations.update('f6692544-3265-49be-9711-bbdcebc079e4', {
name: 'openai-prod',
description: 'Production OpenAI',
});

delete()​

delete(integrationId, organisationId): Promise<void>;

Defined in: src/ai-gateway/integrations-client.ts:331

Delete an integration.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.
organisationIdstringThe TSG as a numeric string; sent as a query param.

Returns​

Promise<void>

Nothing — the API replies 200 with an empty body.

Example​

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

await gw.integrations.delete('f6692544-3265-49be-9711-bbdcebc079e4', '1852583913');

getModels()​

getModels(integrationId): Promise<objectOutputType<{
models: ZodArray<ZodObject<{
slug: ZodString;
enabled: ZodBoolean;
name: ZodOptional<ZodString>;
is_custom: ZodOptional<ZodNullable<ZodUnion<[ZodBoolean, ZodLiteral<...>, ZodLiteral<...>]>>>;
is_finetune: ZodOptional<ZodNullable<ZodUnion<[ZodBoolean, ZodLiteral<...>, ZodLiteral<...>]>>>;
base_model_slug: ZodOptional<ZodNullable<ZodString>>;
pricing_config: ZodOptional<ZodNullable<ZodType<{
[key: string]: unknown;
type?: ... | ...;
pay_as_you_go?: ... | ...;
}, ZodTypeDef, {
[key: string]: unknown;
type?: ... | ...;
pay_as_you_go?: ... | ...;
}>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
slug: ZodString;
enabled: ZodBoolean;
name: ZodOptional<ZodString>;
is_custom: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>;
is_finetune: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>;
base_model_slug: ZodOptional<ZodNullable<ZodString>>;
pricing_config: ZodOptional<ZodNullable<ZodType<{
[key: ...]: ...;
type?: ...;
pay_as_you_go?: ...;
}, ZodTypeDef, {
[key: ...]: ...;
type?: ...;
pay_as_you_go?: ...;
}>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
slug: ZodString;
enabled: ZodBoolean;
name: ZodOptional<ZodString>;
is_custom: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>;
is_finetune: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>;
base_model_slug: ZodOptional<ZodNullable<ZodString>>;
pricing_config: ZodOptional<ZodNullable<ZodType<{
[key: ...]: ...;
type?: ...;
pay_as_you_go?: ...;
}, ZodTypeDef, {
[key: ...]: ...;
type?: ...;
pay_as_you_go?: ...;
}>>>;
}, ZodTypeAny, "passthrough">>, "many">;
total: ZodOptional<ZodNumber>;
allow_all_models: ZodBoolean;
object: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:360

Read which models this integration exposes.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.

Returns​

Promise<objectOutputType<{ models: ZodArray<ZodObject<{ slug: ZodString; enabled: ZodBoolean; name: ZodOptional<ZodString>; is_custom: ZodOptional<ZodNullable<ZodUnion<[ZodBoolean, ZodLiteral<...>, ZodLiteral<...>]>>>; is_finetune: ZodOptional<ZodNullable<ZodUnion<[ZodBoolean, ZodLiteral<...>, ZodLiteral<...>]>>>; base_model_slug: ZodOptional<ZodNullable<ZodString>>; pricing_config: ZodOptional<ZodNullable<ZodType<{ [key: string]: unknown; type?: ... | ...; pay_as_you_go?: ... | ...; }, ZodTypeDef, { [key: string]: unknown; type?: ... | ...; pay_as_you_go?: ... | ...; }>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ slug: ZodString; enabled: ZodBoolean; name: ZodOptional<ZodString>; is_custom: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>; is_finetune: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>; base_model_slug: ZodOptional<ZodNullable<ZodString>>; pricing_config: ZodOptional<ZodNullable<ZodType<{ [key: ...]: ...; type?: ...; pay_as_you_go?: ...; }, ZodTypeDef, { [key: ...]: ...; type?: ...; pay_as_you_go?: ...; }>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ slug: ZodString; enabled: ZodBoolean; name: ZodOptional<ZodString>; is_custom: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>; is_finetune: ZodOptional<ZodNullable<ZodUnion<[..., ..., ...]>>>; base_model_slug: ZodOptional<ZodNullable<ZodString>>; pricing_config: ZodOptional<ZodNullable<ZodType<{ [key: ...]: ...; type?: ...; pay_as_you_go?: ...; }, ZodTypeDef, { [key: ...]: ...; type?: ...; pay_as_you_go?: ...; }>>>; }, ZodTypeAny, "passthrough">>, "many">; total: ZodOptional<ZodNumber>; allow_all_models: ZodBoolean; object: ZodString; }, ZodTypeAny, "passthrough">>

Per-model enablement plus the allow_all_models flag.

Example​

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

const m = await gw.integrations.getModels('f6692544-3265-49be-9711-bbdcebc079e4');
// m.models[0] => { slug: 'gpt-4', enabled: true }

setModels()​

setModels(integrationId, body): Promise<objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
success: ZodOptional<ZodBoolean>;
data: ZodOptional<ZodUnion<[ZodObject<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:387

Bulk-update model enablement for this integration.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.
body{ models: { slug: string; enabled: boolean; is_custom?: boolean | null; is_finetune?: boolean | null; base_model_slug?: string | null; configurations?: { custom_host?: string; custom_headers?: objectOutputType<{ key: ZodOptional<ZodString>; value: ZodOptional<ZodString>; }, ZodString, "strip">; } & GatewayJsonObject; pricing_config?: { type?: string; pay_as_you_go?: { request_token?: { price?: ... | ...; }; response_token?: { price?: ... | ...; }; }; } & GatewayJsonObject; }[]; allow_all_models?: boolean; }One or more model entries to update; omission is not documented as deletion.
body.models{ slug: string; enabled: boolean; is_custom?: boolean | null; is_finetune?: boolean | null; base_model_slug?: string | null; configurations?: { custom_host?: string; custom_headers?: objectOutputType<{ key: ZodOptional<ZodString>; value: ZodOptional<ZodString>; }, ZodString, "strip">; } & GatewayJsonObject; pricing_config?: { type?: string; pay_as_you_go?: { request_token?: { price?: ... | ...; }; response_token?: { price?: ... | ...; }; }; } & GatewayJsonObject; }[]-
body.allow_all_models?boolean-

Returns​

Promise<objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; success: ZodOptional<ZodBoolean>; data: ZodOptional<ZodUnion<[ZodObject<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>; }, ZodTypeAny, "passthrough">>

The raw response. Shape unverified against a live tenant — see the PRD.

Example​

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

await gw.integrations.setModels('f6692544-3265-49be-9711-bbdcebc079e4', {
models: [{ slug: 'gpt-4', enabled: true }, { slug: 'gpt-4-32k', enabled: false }],
});

getWorkspaces()​

getWorkspaces(integrationId): Promise<objectOutputType<{
total: ZodOptional<ZodNumber>;
workspaces: ZodArray<ZodObject<{
id: ZodString;
usage_limits: ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>;
rate_limits: ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>;
enabled: ZodBoolean;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
last_reset_at: ZodNullable<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodString;
usage_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>;
rate_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>;
enabled: ZodBoolean;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
last_reset_at: ZodNullable<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodString;
usage_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>;
rate_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>;
enabled: ZodBoolean;
status: ZodString;
created_at: ZodString;
last_updated_at: ZodNullable<ZodString>;
last_reset_at: ZodNullable<ZodString>;
}, ZodTypeAny, "passthrough">>, "many">;
global_workspace_access: ZodObject<{
enabled: ZodBoolean;
rate_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>>;
usage_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
enabled: ZodBoolean;
rate_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>;
usage_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
enabled: ZodBoolean;
rate_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>;
usage_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>;
}, ZodTypeAny, "passthrough">>;
object: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:423

Read which workspaces may use this integration.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.

Returns​

Promise<objectOutputType<{ total: ZodOptional<ZodNumber>; workspaces: ZodArray<ZodObject<{ id: ZodString; usage_limits: ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>; rate_limits: ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>; enabled: ZodBoolean; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; last_reset_at: ZodNullable<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; usage_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>; rate_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>; enabled: ZodBoolean; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; last_reset_at: ZodNullable<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; usage_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>; rate_limits: ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>; enabled: ZodBoolean; status: ZodString; created_at: ZodString; last_updated_at: ZodNullable<ZodString>; last_reset_at: ZodNullable<ZodString>; }, ZodTypeAny, "passthrough">>, "many">; global_workspace_access: ZodObject<{ enabled: ZodBoolean; rate_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>>; usage_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">, ZodRecord<ZodString, ZodUnknown>]>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ enabled: ZodBoolean; rate_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>; usage_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ enabled: ZodBoolean; rate_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>; usage_limits: ZodOptional<ZodNullable<ZodUnion<[ZodArray<..., ...>, ZodRecord<..., ...>]>>>; }, ZodTypeAny, "passthrough">>; object: ZodString; }, ZodTypeAny, "passthrough">>

Bound workspaces plus the global_workspace_access object.

Remarks​

global_workspace_access is an object on this read, not a boolean, despite the field name — { enabled, rate_limits, usage_limits }. The corresponding write (setWorkspaces) uses the same object shape.

Example​

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

const w = await gw.integrations.getWorkspaces('f6692544-3265-49be-9711-bbdcebc079e4');
// w.global_workspace_access => { enabled: false, rate_limits: null, usage_limits: null }

setWorkspaces()​

setWorkspaces(integrationId, body): Promise<objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
success: ZodOptional<ZodBoolean>;
data: ZodOptional<ZodUnion<[ZodObject<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodOptional<ZodString>;
slug: ZodOptional<ZodString>;
version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/integrations-client.ts:450

Bulk-update which workspaces may use this integration.

Parameters​

ParameterTypeDescription
integrationIdstringIntegration UUID.
body{ [key: string]: any; }Workspace bindings, global-access settings, or explicit override behavior.

Returns​

Promise<objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; success: ZodOptional<ZodBoolean>; data: ZodOptional<ZodUnion<[ZodObject<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodOptional<ZodString>; slug: ZodOptional<ZodString>; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, ZodString, ZodNumber]>>; }, ZodTypeAny, "passthrough">>

The raw response. Shape unverified against a live tenant — see the PRD.

Example​

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

await gw.integrations.setWorkspaces('f6692544-3265-49be-9711-bbdcebc079e4', {
global_workspace_access: { enabled: true },
});