Example Usage
import { PrivateEndpoint } from "@openrouter/sdk/models";
let value: PrivateEndpoint = {
baseUrl: "https://contoso.openai.azure.com",
declaredRegion: "us",
declaredZdr: true,
id: "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
modelName: "OpenAI: GPT-4o",
modelPermaslug: "openai/gpt-4o-2024-08-06",
modelSlug: "openai/gpt-4o",
pricing: {
completion: "0.00001",
prompt: "0.0000025",
},
providerName: "Azure",
providerSlug: "azure",
status: "active",
upstreamModelId: "gpt-4o-prod",
};
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
baseUrl | string | :heavy_check_mark: | HTTPS base URL of your deployment, or null for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com |
declaredRegion | models.PrivateEndpointDeclaredRegion | :heavy_check_mark: | Where you attest this deployment processes data. global means not regional; null means undeclared. | us |
declaredZdr | boolean | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. null means undeclared. | true |
id | string | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 |
modelName | string | :heavy_check_mark: | Display name of the model, or null when the model is no longer listed. | OpenAI: GPT-4o |
modelPermaslug | string | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 |
modelSlug | string | :heavy_check_mark: | Public model slug, or null when the model is no longer listed. | openai/gpt-4o |
pricing | models.PrivateEndpointPricing | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | { “completion”: “0.00001”, “prompt”: “0.0000025” } |
providerName | string | :heavy_check_mark: | Display name of the upstream provider. | Azure |
providerSlug | string | :heavy_check_mark: | Slug of the upstream provider, or null when the provider is no longer listed. | azure |
status | models.PrivateEndpointStatus | :heavy_check_mark: | Lifecycle state. draft endpoints are not routable until validated and activated; disabled endpoints are activated but temporarily not routable. | active |
upstreamModelId | string | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod |