Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
base_url | Nullable[str] | :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 |
declared_region | Nullable[components.PrivateEndpointDeclaredRegion] | :heavy_check_mark: | Where you attest this deployment processes data. global means not regional; null means undeclared. | us |
declared_zdr | Nullable[bool] | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. null means undeclared. | true |
id | str | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 |
model_name | Nullable[str] | :heavy_check_mark: | Display name of the model, or null when the model is no longer listed. | OpenAI: GPT-4o |
model_permaslug | str | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 |
model_slug | Nullable[str] | :heavy_check_mark: | Public model slug, or null when the model is no longer listed. | openai/gpt-4o |
pricing | components.PrivateEndpointPricing | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | { “completion”: “0.00001”, “prompt”: “0.0000025” } |
provider_name | str | :heavy_check_mark: | Display name of the upstream provider. | Azure |
provider_slug | Nullable[str] | :heavy_check_mark: | Slug of the upstream provider, or null when the provider is no longer listed. | azure |
status | components.PrivateEndpointStatus | :heavy_check_mark: | Lifecycle state. draft endpoints are not routable until validated and activated; disabled endpoints are activated but temporarily not routable. | active |
upstream_model_id | str | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod |