Skip to content

chore: update OpenAPI spec from monorepo #809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openrouter-docs-sync merged 1 commit into from
Aug 13, 2026
Merged

chore: update OpenAPI spec from monorepo #809

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 77 additions & 70 deletions .speakeasy/in.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1565,6 +1565,59 @@ components:
type:
- 'object'
- 'null'
AnthropicMessagesErrorResponse:
description: 'Error response from the Anthropic Messages API'
example:
error:
error_type: 'invalid_request'
message: 'Invalid request: messages field is required'
type: 'invalid_request_error'
request_id: null
type: 'error'
properties:
error:
properties:
error_type:
$ref: '#/components/schemas/ApiErrorType'
message:
type: 'string'
type:
enum:
- 'invalid_request_error'
- 'authentication_error'
- 'permission_error'
- 'not_found_error'
- 'rate_limit_error'
- 'api_error'
- 'overloaded_error'
- 'billing_error'
- 'timeout_error'
type: 'string'
required:
- 'type'
- 'message'
type: 'object'
metadata:
additionalProperties: {}
type: 'object'
openrouter_metadata:
additionalProperties: {}
type:
- 'object'
- 'null'
request_id:
type:
- 'string'
- 'null'
type:
enum:
- 'error'
type: 'string'
required:
- 'type'
- 'error'
- 'request_id'
type: 'object'
AnthropicMessageUsageIteration:
allOf:
- $ref: '#/components/schemas/AnthropicBaseUsageIteration'
Expand Down Expand Up @@ -10338,7 +10391,7 @@ components:
example: 'bytedance-seed/seedream-4.5'
type: 'string'
'n':
description: 'Number of images to generate (1-10). Providers that only support single-image generation reject n > 1.'
description: 'Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1.'
example: 1
type: 'integer'
output_compression:
Expand Down Expand Up @@ -12653,22 +12706,6 @@ components:
- 'delta'
- 'usage'
type: 'object'
MessagesErrorDetail:
example:
error_type: 'invalid_request'
message: 'Invalid request parameters'
type: 'invalid_request_error'
properties:
error_type:
$ref: '#/components/schemas/ApiErrorType'
message:
type: 'string'
type:
type: 'string'
required:
- 'type'
- 'message'
type: 'object'
MessagesErrorEvent:
description: 'Error event in the stream'
example:
Expand Down Expand Up @@ -12700,23 +12737,6 @@ components:
- 'type'
- 'error'
type: 'object'
MessagesErrorResponse:
example:
error:
message: 'Invalid request parameters'
type: 'invalid_request_error'
type: 'error'
properties:
error:
$ref: '#/components/schemas/MessagesErrorDetail'
type:
enum:
- 'error'
type: 'string'
required:
- 'type'
- 'error'
type: 'object'
MessagesFallbackParam:
additionalProperties: {}
description: 'Fallback model to try when the primary model fails or refuses. Only the `model` field is supported; per-attempt overrides are rejected.'
Expand Down Expand Up @@ -33582,9 +33602,10 @@ paths:
error:
message: 'Invalid request: messages is required'
type: 'invalid_request_error'
request_id: null
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Invalid request error'
'401':
content:
Expand All @@ -33593,9 +33614,10 @@ paths:
error:
message: 'Invalid API key'
type: 'authentication_error'
request_id: null
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Authentication error'
'403':
content:
Expand All @@ -33605,56 +33627,37 @@ paths:
summary: 'Guardrail blocked the request'
value:
error:
code: 403
message: 'Request blocked: prompt injection patterns detected'
metadata:
patterns:
- 'ignore all previous instructions'
type: 'permission_error'
openrouter_metadata:
attempt: 1
endpoints:
available:
- model: 'openai/gpt-4o'
provider: 'OpenAI'
selected: false
total: 1
is_byok: false
pipeline:
- data:
action: 'blocked'
detected: true
engines:
- 'regex'
patterns:
- 'ignore all previous instructions'
guardrail_id: 'grd_abc123'
guardrail_scope: 'api-key'
name: 'regex_pi_detection'
- name: 'regex_pi_detection'
summary: 'Blocked: prompt injection detected (1 pattern matched)'
type: 'guardrail'
region: 'iad'
requested: 'openai/gpt-4o'
strategy: 'direct'
summary: 'available=1'
request_id: null
type: 'error'
insufficient-permissions:
summary: 'Insufficient permissions'
value:
error:
code: 403
message: 'Only management keys can perform this operation'
type: 'permission_error'
request_id: null
type: 'error'
schema:
$ref: '#/components/schemas/ForbiddenResponse'
description: 'Forbidden - Authentication successful but insufficient permissions, or a guardrail blocked the request. When guardrails block and the `X-OpenRouter-Metadata: enabled` header is present, the response includes `openrouter_metadata` with full routing context and a `pipeline` array containing guardrail stage details.'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Forbidden error'
'404':
content:
application/json:
example:
error:
message: 'Model not found'
type: 'not_found_error'
request_id: 'gen-xxxxxxxxxxxxxxxxxxxxxxxx'
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Not found error'
'429':
content:
Expand All @@ -33663,9 +33666,10 @@ paths:
error:
message: 'Rate limit exceeded'
type: 'rate_limit_error'
request_id: 'gen-xxxxxxxxxxxxxxxxxxxxxxxx'
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Rate limit error'
'500':
content:
Expand All @@ -33674,9 +33678,10 @@ paths:
error:
message: 'Internal server error'
type: 'api_error'
request_id: 'gen-xxxxxxxxxxxxxxxxxxxxxxxx'
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'API error'
'503':
content:
Expand All @@ -33685,9 +33690,10 @@ paths:
error:
message: 'Service temporarily overloaded'
type: 'overloaded_error'
request_id: 'gen-xxxxxxxxxxxxxxxxxxxxxxxx'
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Overloaded error'
'529':
content:
Expand All @@ -33696,9 +33702,10 @@ paths:
error:
message: 'Provider is temporarily overloaded'
type: 'overloaded_error'
request_id: 'gen-xxxxxxxxxxxxxxxxxxxxxxxx'
type: 'error'
schema:
$ref: '#/components/schemas/MessagesErrorResponse'
$ref: '#/components/schemas/AnthropicMessagesErrorResponse'
description: 'Overloaded error'
summary: 'Create a message'
tags:
Expand Down
Loading