Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Activate | *components.PrivateEndpointActivation | ➖ | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call /validate and /activate instead of creating it again. | { “workspace_id”: “550e8400-e29b-41d4-a716-446655440000” } |
BaseURL | *string | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com |
DeclaredParameters | []components.PrivateEndpointDeclaredParameter | ➖ | Parameters the upstream supports beyond the tested ones. Replaces the earlier declaration; tested parameters stay. Order and repeated names are ignored, but the list holds at most as many entries as there are declarable parameters, repeats included. tool_choice requires tools to be tested or declared. | [ “temperature”, “seed” ] |
DeclaredRegion | optionalnullable.OptionalNullable[components.CreatePrivateEndpointRequestDeclaredRegion] | ➖ | Attest where this deployment processes data. | us |
DeclaredZdr | optionalnullable.OptionalNullable[bool] | ➖ | Attest that this deployment retains no prompt or completion data. | |
MaxCompletionTokens | *int64 | ➖ | Cap on completion tokens per request. Requests asking for more skip this endpoint, and the default output length stays within it. When omitted, the cap is copied from the public endpoint for the same model and provider, if there is one. | 131072 |
ModelPermaslug | string | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 |
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” } |
ProviderSlug | string | ✅ | Slug of the upstream provider. | azure |
UpstreamModelID | string | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod |