Skip to content

Commit 56d3712

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

1 file changed

Lines changed: 165 additions & 1 deletion

File tree

‎.speakeasy/in.openapi.yaml‎

Lines changed: 165 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5221,6 +5221,17 @@ components:
52215221
required:
52225222
- 'error'
52235223
type: 'object'
5224+
BatchInputReference:
5225+
additionalProperties: false
5226+
description: 'A batch input file in your own storage, named in place of `requests`. Available to allowlisted callers on Google Vertex BYOK endpoints only.'
5227+
properties:
5228+
uri:
5229+
description: 'Cloud Storage URI of the batch input file, in the form `gs://bucket/object`. The file stays in your bucket and must already be in the provider batch input format.'
5230+
example: 'gs://my-bucket/batches/input.jsonl'
5231+
type: 'string'
5232+
required:
5233+
- 'uri'
5234+
type: 'object'
52245235
BatchListItem:
52255236
description: 'Metadata-only batch object. `results` is always `null` in list responses.'
52265237
properties:
@@ -5258,6 +5269,8 @@ components:
52585269
enum:
52595270
- 'batch'
52605271
type: 'string'
5272+
output:
5273+
$ref: '#/components/schemas/BatchOutputReference'
52615274
provider:
52625275
description: 'Provider OpenRouter assigned to run the batch, using the same name as the `provider` field of sync responses.'
52635276
type:
@@ -5514,6 +5527,8 @@ components:
55145527
enum:
55155528
- 'batch'
55165529
type: 'string'
5530+
output:
5531+
$ref: '#/components/schemas/BatchOutputReference'
55175532
provider:
55185533
description: 'Provider OpenRouter assigned to run the batch, using the same name as the `provider` field of sync responses.'
55195534
type:
@@ -6494,6 +6509,16 @@ components:
64946509
- 'results'
64956510
- 'error'
64966511
type: 'object'
6512+
BatchOutputReference:
6513+
description: 'The output location of a batch submitted with `input`, whose `results` are `null`. Returned only by `GET /batches/{id}`, once the batch has ended and the provider reported an output folder. Batch lists and responses for a batch with an unpaid charge leave it out.'
6514+
properties:
6515+
uri:
6516+
description: 'URI of the batch output in your own storage. For a Cloud Storage input file it is the output folder, in the form `gs://bucket/folder`, and the files are in the provider batch output format.'
6517+
example: 'gs://my-bucket/openrouter-batch/output/org_abc/batch_123/batch_123/prediction-model-2026-01-01T00:00:00.000000Z'
6518+
type: 'string'
6519+
required:
6520+
- 'uri'
6521+
type: 'object'
64976522
BatchPaymentRequiredResponse:
64986523
description: 'Batch metadata with results withheld (results: null) plus the standard error envelope. Add credits to unlock the already-computed results; the batch is not re-run.'
64996524
properties:
@@ -6532,6 +6557,8 @@ components:
65326557
enum:
65336558
- 'batch'
65346559
type: 'string'
6560+
output:
6561+
$ref: '#/components/schemas/BatchOutputReference'
65356562
provider:
65366563
description: 'Provider OpenRouter assigned to run the batch, using the same name as the `provider` field of sync responses.'
65376564
type:
@@ -6743,12 +6770,15 @@ components:
67436770
- '/v1/embeddings'
67446771
- '/v1/audio/speech'
67456772
type: 'string'
6773+
input:
6774+
$ref: '#/components/schemas/BatchInputReference'
67466775
model:
67476776
minLength: 1
67486777
type: 'string'
67496778
provider:
67506779
$ref: '#/components/schemas/BatchProviderPreferences'
67516780
requests:
6781+
description: 'The batch requests. Send exactly one of `requests` or `input`; `requests` must be the last field in the request body.'
67526782
items:
67536783
properties:
67546784
body:
@@ -6767,7 +6797,6 @@ components:
67676797
required:
67686798
- 'endpoint'
67696799
- 'model'
6770-
- 'requests'
67716800
type: 'object'
67726801
BooleanCapability:
67736802
description: 'A supported-or-not flag. Present means the parameter is accepted.'
@@ -16658,6 +16687,139 @@ components:
1665816687
- 'throughput'
1665916688
- 'request_count'
1666016689
type: 'object'
16690+
ImageGenerationLayer:
16691+
description: 'Layer metadata, present when the request asked the provider to split the image into layers (Seedream: `provider.options.seed.layer_decomposition: true` with the required `layer_decomposition_options.max_images`, 2 to 16). Decomposition requires `n` to be 1 or omitted; the response returns up to `max_images` images (the base image plus its layers).'
16692+
example:
16693+
background: 'transparent'
16694+
bounding_box:
16695+
absolute:
16696+
- 238
16697+
- 124
16698+
- 786
16699+
- 673
16700+
normalized:
16701+
- 232
16702+
- 121
16703+
- 768
16704+
- 657
16705+
description: 'A solid red circle'
16706+
name: 'Red circle'
16707+
z_index: 1
16708+
properties:
16709+
background:
16710+
description: 'Whether the layer image has a transparent background'
16711+
enum:
16712+
- 'opaque'
16713+
- 'transparent'
16714+
type: 'string'
16715+
bounding_box:
16716+
$ref: '#/components/schemas/ImageGenerationLayerBoundingBox'
16717+
description:
16718+
description: 'Provider description of the layer'
16719+
type: 'string'
16720+
name:
16721+
description: 'Short provider-assigned layer name'
16722+
type: 'string'
16723+
text_recognition:
16724+
$ref: '#/components/schemas/ImageGenerationLayerTextRecognition'
16725+
z_index:
16726+
description: 'Stacking order; 0 is the opaque base image and higher values sit on top'
16727+
type: 'integer'
16728+
required:
16729+
- 'z_index'
16730+
type: 'object'
16731+
ImageGenerationLayerBoundingBox:
16732+
description: 'Where a layer sits on the base image'
16733+
example:
16734+
absolute:
16735+
- 238
16736+
- 124
16737+
- 786
16738+
- 673
16739+
normalized:
16740+
- 232
16741+
- 121
16742+
- 768
16743+
- 657
16744+
properties:
16745+
absolute:
16746+
description: 'Layer box in pixels of the base image, as `[x_min, y_min, x_max, y_max]`'
16747+
items:
16748+
type: 'integer'
16749+
maxItems: 4
16750+
minItems: 4
16751+
type: 'array'
16752+
normalized:
16753+
description: 'Layer box scaled to 0-1000 on each axis, as `[x_min, y_min, x_max, y_max]`'
16754+
items:
16755+
type: 'integer'
16756+
maxItems: 4
16757+
minItems: 4
16758+
type: 'array'
16759+
required:
16760+
- 'absolute'
16761+
- 'normalized'
16762+
type: 'object'
16763+
ImageGenerationLayerTextRecognition:
16764+
description: 'Text found in the layer, present when the provider ran text recognition'
16765+
example:
16766+
lines:
16767+
- bounding_box:
16768+
absolute:
16769+
- 238
16770+
- 124
16771+
- 786
16772+
- 673
16773+
normalized:
16774+
- 232
16775+
- 121
16776+
- 768
16777+
- 657
16778+
runs:
16779+
- text: 'SALE'
16780+
text: 'SALE'
16781+
properties:
16782+
lines:
16783+
items:
16784+
properties:
16785+
bounding_box:
16786+
$ref: '#/components/schemas/ImageGenerationLayerBoundingBox'
16787+
runs:
16788+
items:
16789+
$ref: '#/components/schemas/ImageGenerationLayerTextRun'
16790+
type: 'array'
16791+
required:
16792+
- 'runs'
16793+
type: 'object'
16794+
type: 'array'
16795+
text:
16796+
description: 'Full text recognized in the layer'
16797+
type: 'string'
16798+
required:
16799+
- 'text'
16800+
type: 'object'
16801+
ImageGenerationLayerTextRun:
16802+
description: 'A run of text that shares one style'
16803+
example:
16804+
style:
16805+
bold: true
16806+
similar_font_family: 'Menlo'
16807+
text: 'SALE'
16808+
properties:
16809+
style:
16810+
additionalProperties:
16811+
anyOf:
16812+
- type: 'string'
16813+
- type: 'boolean'
16814+
- format: 'double'
16815+
type: 'number'
16816+
description: 'Font and style the provider recognized for this run, e.g. `similar_font_family`, `foreground_color`, `bold`'
16817+
type: 'object'
16818+
text:
16819+
type: 'string'
16820+
required:
16821+
- 'text'
16822+
type: 'object'
1666116823
ImageGenerationProviderPreferences:
1666216824
description: 'Provider routing preferences and provider-specific passthrough configuration.'
1666316825
example:
@@ -16892,6 +17054,8 @@ components:
1689217054
b64_json:
1689317055
description: 'Base64-encoded image bytes'
1689417056
type: 'string'
17057+
layer:
17058+
$ref: '#/components/schemas/ImageGenerationLayer'
1689517059
media_type:
1689617060
description: 'Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined.'
1689717061
example: 'image/png'

0 commit comments

Comments
 (0)