Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
BaseURL | *string | ✅ | 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 |
DeclaredParameters | []string | ✅ | Parameters you declared the upstream supports. Requests that use a parameter only route to this endpoint when it is tested or declared. | [ “temperature”, “seed” ] |
DeclaredRegion | *components.PrivateEndpointDeclaredRegion | ✅ | Where you attest this deployment processes data. global means not regional; null means undeclared. | us |
DeclaredZdr | *bool | ✅ | Whether you attest this deployment retains no prompt or completion data. null means undeclared. | true |
ID | string | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 |
MaxCompletionTokens | optionalnullable.OptionalNullable[int64] | ➖ | Most completion tokens a request routed to this endpoint can produce, or null when the endpoint sets no cap beyond the model context length. | 131072 |
ModelName | *string | ✅ | Display name of the model, or null when the model is no longer listed. | OpenAI: GPT-4o |
ModelPermaslug | string | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 |
ModelSlug | *string | ✅ | Public model slug, or null when the model is no longer listed. | openai/gpt-4o |
Pricing | components.PrivateEndpointPricing | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | { “cache_read”: “0.00000025”, “cache_write”: “0.000003125”, “completion”: “0.00001”, “prompt”: “0.0000025” } |
ProviderName | string | ✅ | Display name of the upstream provider. | Azure |
ProviderSlug | *string | ✅ | Slug of the upstream provider, or null when the provider is no longer listed. | azure |
Status | components.PrivateEndpointStatus | ✅ | Lifecycle state. draft endpoints are not routable until validated and activated; disabled endpoints are activated but temporarily not routable. | active |
TestedParameters | []string | ✅ | Parameters a validation run proved the upstream honors (tools, tool_choice, response_format, structured_outputs, stop). Read-only; cleared when the upstream configuration changes. | [ “tools”, “tool_choice”, “response_format” ] |
UpstreamModelID | string | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod |