import * as z from "zod/v4"; import { OpenEnum } from "../types/enums.js"; import { BYOKProviderSlug } from "./byokproviderslug.js"; /** * Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, Azure accepts `europe` or `us` and Anthropic accepts `us` only. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. */ export declare const CreateBYOKKeyRequestDeclaredRegion: { readonly Global: "global"; readonly Europe: "europe"; readonly Us: "us"; }; /** * Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, Azure accepts `europe` or `us` and Anthropic accepts `us` only. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. */ export type CreateBYOKKeyRequestDeclaredRegion = OpenEnum; export type CreateBYOKKeyRequest = { /** * Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400; for a credential pinned to a workspace, so do hashes of API keys outside that workspace. */ allowedApiKeyHashes?: Array | null | undefined; /** * Optional allowlist of model slugs this credential may be used for. `null` means no restriction. */ allowedModels?: Array | null | undefined; /** * Optional allowlist of user IDs that may use this credential. `null` means no restriction. */ allowedUserIds?: Array | null | undefined; /** * Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, Azure accepts `europe` or `us` and Anthropic accepts `us` only. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. */ declaredRegion?: CreateBYOKKeyRequestDeclaredRegion | null | undefined; /** * Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. */ declaredZdr?: boolean | null | undefined; /** * Whether this credential should be created in a disabled state. */ disabled?: boolean | undefined; /** * Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. */ isByokOnly?: boolean | undefined; /** * Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. */ isFallback?: boolean | undefined; /** * Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. */ isRequired?: boolean | undefined; /** * The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. */ key: string; /** * Optional human-readable name for the credential. */ name?: string | null | undefined; /** * The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). */ provider: BYOKProviderSlug; /** * Optional workspace ID to scope the credential to. When omitted, a workspace-scoped management key creates it in its own workspace. An organization management key creates it in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. */ workspaceId?: string | undefined; }; /** @internal */ export declare const CreateBYOKKeyRequestDeclaredRegion$outboundSchema: z.ZodType; /** @internal */ export type CreateBYOKKeyRequest$Outbound = { allowed_api_key_hashes?: Array | null | undefined; allowed_models?: Array | null | undefined; allowed_user_ids?: Array | null | undefined; declared_region?: string | null | undefined; declared_zdr?: boolean | null | undefined; disabled?: boolean | undefined; is_byok_only?: boolean | undefined; is_fallback?: boolean | undefined; is_required?: boolean | undefined; key: string; name?: string | null | undefined; provider: string; workspace_id?: string | undefined; }; /** @internal */ export declare const CreateBYOKKeyRequest$outboundSchema: z.ZodType; export declare function createBYOKKeyRequestToJSON(createBYOKKeyRequest: CreateBYOKKeyRequest): string; //# sourceMappingURL=createbyokkeyrequest.d.ts.map