Skip to content

Commit f68fe91

Browse files
openrouter-docs-sync[bot]OpenRouter SDK Bot
andauthored
chore: update OpenAPI spec from monorepo (#1149)
Co-authored-by: OpenRouter SDK Bot <sdk-bot@openrouter.ai>
1 parent 9691915 commit f68fe91

1 file changed

Lines changed: 245 additions & 2 deletions

File tree

‎.speakeasy/in.openapi.yaml‎

Lines changed: 245 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10299,6 +10299,15 @@ components:
1029910299
example: 'https://contoso.openai.azure.com'
1030010300
minLength: 1
1030110301
type: 'string'
10302+
declared_parameters:
10303+
description: '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.'
10304+
example:
10305+
- 'temperature'
10306+
- 'seed'
10307+
items:
10308+
$ref: '#/components/schemas/PrivateEndpointDeclaredParameter'
10309+
maxItems: 25
10310+
type: 'array'
1030210311
declared_region:
1030310312
description: 'Attest where this deployment processes data.'
1030410313
enum:
@@ -10315,6 +10324,12 @@ components:
1031510324
type:
1031610325
- 'boolean'
1031710326
- 'null'
10327+
max_completion_tokens:
10328+
description: '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.'
10329+
example: 131072
10330+
maximum: 2147483647
10331+
minimum: 1
10332+
type: 'integer'
1031810333
model_permaslug:
1031910334
description: 'Permanent slug of the model this endpoint serves.'
1032010335
example: 'openai/gpt-4o-2024-08-06'
@@ -16039,6 +16054,12 @@ components:
1603916054
type:
1604016055
- 'boolean'
1604116056
- 'null'
16057+
max_completion_tokens:
16058+
description: 'Most completion tokens a request routed to this endpoint can produce, or `null` when the endpoint sets no cap beyond the model context length.'
16059+
example: 131072
16060+
type:
16061+
- 'integer'
16062+
- 'null'
1604216063
required:
1604316064
- 'declared_zdr'
1604416065
- 'declared_region'
@@ -25410,9 +25431,13 @@ components:
2541025431
PrivateEndpoint:
2541125432
example:
2541225433
base_url: 'https://contoso.openai.azure.com'
25434+
declared_parameters:
25435+
- 'temperature'
25436+
- 'seed'
2541325437
declared_region: 'us'
2541425438
declared_zdr: true
2541525439
id: '5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11'
25440+
max_completion_tokens: 131072
2541625441
model_name: 'OpenAI: GPT-4o'
2541725442
model_permaslug: 'openai/gpt-4o-2024-08-06'
2541825443
model_slug: 'openai/gpt-4o'
@@ -25424,6 +25449,10 @@ components:
2542425449
provider_name: 'Azure'
2542525450
provider_slug: 'azure'
2542625451
status: 'active'
25452+
tested_parameters:
25453+
- 'tools'
25454+
- 'tool_choice'
25455+
- 'response_format'
2542725456
upstream_model_id: 'gpt-4o-prod'
2542825457
properties:
2542925458
base_url:
@@ -25432,6 +25461,14 @@ components:
2543225461
type:
2543325462
- 'string'
2543425463
- 'null'
25464+
declared_parameters:
25465+
description: 'Parameters you declared the upstream supports. Requests that use a parameter only route to this endpoint when it is tested or declared.'
25466+
example:
25467+
- 'temperature'
25468+
- 'seed'
25469+
items:
25470+
type: 'string'
25471+
type: 'array'
2543525472
declared_region:
2543625473
$ref: '#/components/schemas/PrivateEndpointDeclaredRegion'
2543725474
declared_zdr:
@@ -25445,6 +25482,12 @@ components:
2544525482
example: '5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11'
2544625483
format: 'uuid'
2544725484
type: 'string'
25485+
max_completion_tokens:
25486+
description: 'Most completion tokens a request routed to this endpoint can produce, or `null` when the endpoint sets no cap beyond the model context length.'
25487+
example: 131072
25488+
type:
25489+
- 'integer'
25490+
- 'null'
2544825491
model_name:
2544925492
description: 'Display name of the model, or `null` when the model is no longer listed.'
2545025493
example: 'OpenAI: GPT-4o'
@@ -25475,6 +25518,15 @@ components:
2547525518
- 'null'
2547625519
status:
2547725520
$ref: '#/components/schemas/PrivateEndpointStatus'
25521+
tested_parameters:
25522+
description: 'Parameters a validation run proved the upstream honors (`tools`, `tool_choice`, `response_format`, `structured_outputs`, `stop`). Read-only; cleared when the upstream configuration changes.'
25523+
example:
25524+
- 'tools'
25525+
- 'tool_choice'
25526+
- 'response_format'
25527+
items:
25528+
type: 'string'
25529+
type: 'array'
2547825530
upstream_model_id:
2547925531
description: 'Model or deployment identifier sent to the upstream provider.'
2548025532
example: 'gpt-4o-prod'
@@ -25492,6 +25544,8 @@ components:
2549225544
- 'declared_zdr'
2549325545
- 'declared_region'
2549425546
- 'pricing'
25547+
- 'tested_parameters'
25548+
- 'declared_parameters'
2549525549
type: 'object'
2549625550
PrivateEndpointActivation:
2549725551
description: '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.'
@@ -25559,6 +25613,36 @@ components:
2555925613
- 'validation_stale'
2556025614
example: 'no_byok_key'
2556125615
type: 'string'
25616+
PrivateEndpointDeclaredParameter:
25617+
description: 'A chat request parameter the endpoint accepts.'
25618+
enum:
25619+
- 'temperature'
25620+
- 'top_p'
25621+
- 'top_k'
25622+
- 'min_p'
25623+
- 'top_a'
25624+
- 'frequency_penalty'
25625+
- 'presence_penalty'
25626+
- 'repetition_penalty'
25627+
- 'max_tokens'
25628+
- 'max_completion_tokens'
25629+
- 'logit_bias'
25630+
- 'logprobs'
25631+
- 'top_logprobs'
25632+
- 'prediction'
25633+
- 'seed'
25634+
- 'response_format'
25635+
- 'structured_outputs'
25636+
- 'stop'
25637+
- 'tools'
25638+
- 'tool_choice'
25639+
- 'parallel_tool_calls'
25640+
- 'reasoning'
25641+
- 'reasoning_effort'
25642+
- 'web_search_options'
25643+
- 'verbosity'
25644+
example: 'seed'
25645+
type: 'string'
2556225646
PrivateEndpointDeclaredRegion:
2556325647
description: 'Where you attest this deployment processes data. `global` means not regional; `null` means undeclared.'
2556425648
enum:
@@ -25570,6 +25654,20 @@ components:
2557025654
type:
2557125655
- 'string'
2557225656
- 'null'
25657+
PrivateEndpointParameterCheck:
25658+
example:
25659+
parameter: 'response_format'
25660+
supported: true
25661+
properties:
25662+
parameter:
25663+
example: 'response_format'
25664+
type: 'string'
25665+
supported:
25666+
type: 'boolean'
25667+
required:
25668+
- 'parameter'
25669+
- 'supported'
25670+
type: 'object'
2557325671
PrivateEndpointPricing:
2557425672
description: 'Negotiated per-token rates reported for requests routed to this endpoint.'
2557525673
example:
@@ -25665,6 +25763,11 @@ components:
2566525763
items:
2566625764
$ref: '#/components/schemas/PrivateEndpointCheck'
2566725765
type: 'array'
25766+
parameters:
25767+
description: 'Request parameters probed after the checks passed, each with whether the upstream honored it. Supported ones are recorded in `tested_parameters`. Absent on a failed run and for providers that run no parameter probes; empty when every probe group was already proven.'
25768+
items:
25769+
$ref: '#/components/schemas/PrivateEndpointParameterCheck'
25770+
type: 'array'
2566825771
passed:
2566925772
description: 'Whether every check passed.'
2567025773
example: true
@@ -25679,6 +25782,11 @@ components:
2567925782
items:
2568025783
$ref: '#/components/schemas/PrivateEndpointCheck'
2568125784
type: 'array'
25785+
parameters:
25786+
description: 'Request parameters probed after the checks passed, each with whether the upstream honored it. Supported ones are recorded in `tested_parameters`. Absent on a failed run and for providers that run no parameter probes; empty when every probe group was already proven.'
25787+
items:
25788+
$ref: '#/components/schemas/PrivateEndpointParameterCheck'
25789+
type: 'array'
2568225790
passed:
2568325791
description: 'Whether every check passed.'
2568425792
example: true
@@ -31964,6 +32072,20 @@ components:
3196432072
required:
3196532073
- 'is_filtered_model_catalog_enabled'
3196632074
type: 'object'
32075+
UpdatePrivateEndpointParametersRequest:
32076+
properties:
32077+
declared_parameters:
32078+
description: '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.'
32079+
example:
32080+
- 'temperature'
32081+
- 'seed'
32082+
items:
32083+
$ref: '#/components/schemas/PrivateEndpointDeclaredParameter'
32084+
maxItems: 25
32085+
type: 'array'
32086+
required:
32087+
- 'declared_parameters'
32088+
type: 'object'
3196732089
UpdatePrivateEndpointPricingRequest:
3196832090
properties:
3196932091
pricing:
@@ -46096,12 +46218,12 @@ paths:
4609646218
description: 'Create a private endpoint as a draft. Drafts are not routable: validate one with `POST /private-endpoints/{id}/validate`, then activate it with `POST /private-endpoints/{id}/activate`. Pass `activate` to do all three in one call; if validation fails the draft is kept and returned with the failed checks. Send an `Idempotency-Key` header to make retries safe: a repeated key with the same request returns the endpoint the first request created; reusing it with different fields returns 422 `idempotency_key_reused`. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
4609746219
operationId: 'createPrivateEndpoint'
4609846220
parameters:
46099-
- description: '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, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison.'
46221+
- description: '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.'
4610046222
in: 'header'
4610146223
name: 'idempotency-key'
4610246224
required: false
4610346225
schema:
46104-
description: '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, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison.'
46226+
description: '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.'
4610546227
example: 'wayfair-gpt-4o-eastus-2026-09'
4610646228
maxLength: 255
4610746229
minLength: 1
@@ -46867,6 +46989,127 @@ paths:
4686746989
tags:
4686846990
- 'Private Endpoints'
4686946991
x-speakeasy-name-override: 'enable'
46992+
/private-endpoints/{id}/parameters:
46993+
put:
46994+
description: 'Declare which request parameters the upstream supports beyond the ones validation proved. Applies to drafts and active endpoints; routing picks the change up for subsequent requests. The body replaces the earlier declaration and is read as a set: order and repeated names do not matter, but the list holds at most as many entries as there are declarable parameters, repeats included. `tested_parameters` stay. Returns 400 `parameters_invalid` when `tool_choice` is declared without `tools` being tested or declared. [Management key](/docs/guides/overview/auth/management-api-keys) required.'
46995+
operationId: 'updatePrivateEndpointParameters'
46996+
parameters:
46997+
- description: 'Stable identifier of the private endpoint.'
46998+
in: 'path'
46999+
name: 'id'
47000+
required: true
47001+
schema:
47002+
description: 'Stable identifier of the private endpoint.'
47003+
example: '5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11'
47004+
format: 'uuid'
47005+
type: 'string'
47006+
requestBody:
47007+
content:
47008+
application/json:
47009+
schema:
47010+
$ref: '#/components/schemas/UpdatePrivateEndpointParametersRequest'
47011+
required: true
47012+
responses:
47013+
'200':
47014+
content:
47015+
application/json:
47016+
schema:
47017+
$ref: '#/components/schemas/PrivateEndpointResponse'
47018+
description: 'The endpoint with its new declared parameters'
47019+
'400':
47020+
content:
47021+
application/json:
47022+
example:
47023+
error:
47024+
code: 400
47025+
message: 'Invalid request parameters'
47026+
schema:
47027+
$ref: '#/components/schemas/BadRequestResponse'
47028+
description: 'Bad Request - Invalid request parameters or malformed input'
47029+
'401':
47030+
content:
47031+
application/json:
47032+
example:
47033+
error:
47034+
code: 401
47035+
message: 'Missing Authentication header'
47036+
schema:
47037+
$ref: '#/components/schemas/UnauthorizedResponse'
47038+
description: 'Unauthorized - Authentication required or invalid credentials'
47039+
'403':
47040+
content:
47041+
application/json:
47042+
example:
47043+
error:
47044+
code: 403
47045+
message: 'Only management keys can perform this operation'
47046+
schema:
47047+
$ref: '#/components/schemas/ForbiddenResponse'
47048+
description: 'Forbidden - Authentication successful but insufficient permissions'
47049+
'404':
47050+
content:
47051+
application/json:
47052+
example:
47053+
error:
47054+
code: 404
47055+
message: 'Resource not found'
47056+
schema:
47057+
$ref: '#/components/schemas/NotFoundResponse'
47058+
description: 'Not Found - Resource does not exist'
47059+
'408':
47060+
content:
47061+
application/json:
47062+
example:
47063+
error:
47064+
code: 408
47065+
message: 'Operation timed out. Please try again later.'
47066+
schema:
47067+
$ref: '#/components/schemas/RequestTimeoutResponse'
47068+
description: 'Request Timeout - Operation exceeded time limit'
47069+
'409':
47070+
content:
47071+
application/json:
47072+
example:
47073+
error:
47074+
code: 409
47075+
message: 'Resource conflict. Please try again later.'
47076+
schema:
47077+
$ref: '#/components/schemas/ConflictResponse'
47078+
description: 'Conflict - Resource conflict or concurrent modification'
47079+
'422':
47080+
content:
47081+
application/json:
47082+
example:
47083+
error:
47084+
code: 422
47085+
message: 'Invalid argument'
47086+
schema:
47087+
$ref: '#/components/schemas/UnprocessableEntityResponse'
47088+
description: 'Unprocessable Entity - Semantic validation failure'
47089+
'500':
47090+
content:
47091+
application/json:
47092+
example:
47093+
error:
47094+
code: 500
47095+
message: 'Internal Server Error'
47096+
schema:
47097+
$ref: '#/components/schemas/InternalServerResponse'
47098+
description: 'Internal Server Error - Unexpected server error'
47099+
'502':
47100+
content:
47101+
application/json:
47102+
example:
47103+
error:
47104+
code: 502
47105+
message: 'Provider returned error'
47106+
schema:
47107+
$ref: '#/components/schemas/BadGatewayResponse'
47108+
description: 'Bad Gateway - Provider/upstream API failure'
47109+
summary: 'Set private endpoint supported parameters'
47110+
tags:
47111+
- 'Private Endpoints'
47112+
x-speakeasy-name-override: 'updateParameters'
4687047113
/private-endpoints/{id}/pricing:
4687147114
put:
4687247115
description: 'Set the negotiated per-token rates reported for requests routed to this endpoint. Applies to drafts and active endpoints; new rates take effect for subsequent requests. The body replaces the whole pricing object: omitting `cache_read` or `cache_write` reverts that rate to the provider pricing strategy''s default, even if it was set before. [Management key](/docs/guides/overview/auth/management-api-keys) required.'

0 commit comments

Comments
 (0)