Skip to main content
POST
Create a private endpoint

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Headers

idempotency-key
string

Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, pricing, or declared parameters) is rejected with 422 idempotency_key_reused. Declared parameters are compared as a set, so a retry that reorders or repeats a name replays the endpoint. activate and max_completion_tokens are not compared, and later edits to the endpoint do not affect the comparison.

Required string length: 1 - 255
Example:

"wayfair-gpt-4o-eastus-2026-09"

Body

application/json
model_permaslug
string
required

Permanent slug of the model this endpoint serves.

Minimum string length: 1
Example:

"openai/gpt-4o-2024-08-06"

provider_slug
string
required

Slug of the upstream provider.

Minimum string length: 1
Example:

"azure"

upstream_model_id
string
required

Model or deployment identifier sent to the upstream provider.

Minimum string length: 1
Example:

"gpt-4o-prod"

activate
object

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.

Example:
base_url
string

HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex).

Minimum string length: 1
Example:

"https://contoso.openai.azure.com"

declared_parameters
enum<string>[]

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.

Maximum array length: 25

A chat request parameter the endpoint accepts.

Available options:
temperature,
top_p,
top_k,
min_p,
top_a,
frequency_penalty,
presence_penalty,
repetition_penalty,
max_tokens,
max_completion_tokens,
logit_bias,
logprobs,
top_logprobs,
prediction,
seed,
response_format,
structured_outputs,
stop,
tools,
tool_choice,
parallel_tool_calls,
reasoning,
reasoning_effort,
web_search_options,
verbosity
Example:
declared_region
enum<string> | null

Attest where this deployment processes data.

Available options:
global,
europe,
us,
null
Example:

"us"

declared_zdr
boolean | null

Attest that this deployment retains no prompt or completion data.

max_completion_tokens
integer

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.

Required range: 1 <= x <= 2147483647
Example:

131072

pricing
object

Negotiated per-token rates reported for requests routed to this endpoint.

Example:

Response

The created endpoint: a draft, or active when activate was passed

data
object
required