Skip to content

Commit 7b10fd4

Browse files
robert-j-yOpenRouter SDK Bot
andauthored
chore: update OpenAPI spec from monorepo (#310)
Co-authored-by: OpenRouter SDK Bot <sdk-bot@openrouter.ai>
1 parent 95f2c87 commit 7b10fd4

1 file changed

Lines changed: 57 additions & 47 deletions

File tree

‎.speakeasy/in.openapi.yaml‎

Lines changed: 57 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -5827,33 +5827,35 @@ components:
58275827
properties:
58285828
allowed_domains:
58295829
description: >-
5830-
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers
5831-
(Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains.
5830+
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native
5831+
providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains.
58325832
items:
58335833
type: string
58345834
type: array
58355835
engine:
58365836
$ref: '#/components/schemas/WebSearchEngineEnum'
58375837
excluded_domains:
58385838
description: >-
5839-
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not
5840-
supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains.
5839+
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, and
5840+
xAI. Not supported with OpenAI (silently ignored). Cannot be used with allowed_domains.
58415841
items:
58425842
type: string
58435843
type: array
58445844
max_characters:
58455845
description: >-
5846-
Exact maximum number of characters of content per search result. Applies to the Exa and Parallel engines;
5847-
ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel,
5848-
caps excerpt content per result (default 1,500 when omitted). When both `max_characters` and
5849-
`search_context_size` are set, `max_characters` takes precedence for both engines. When omitted, falls back
5850-
to `search_context_size` mapping (Exa) or engine defaults (Parallel).
5846+
Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and
5847+
Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per
5848+
result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to
5849+
the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to
5850+
the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters`
5851+
takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults
5852+
(Parallel, Perplexity).
58515853
example: 2000
58525854
type: integer
58535855
max_results:
58545856
description: >-
5855-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
5856-
Parallel engines; ignored with native provider search.
5857+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
5858+
Parallel, and Perplexity engines; ignored with native provider search.
58575859
example: 5
58585860
type: integer
58595861
max_total_results:
@@ -9912,8 +9914,8 @@ components:
99129914
$ref: '#/components/schemas/WebSearchDomainFilter'
99139915
max_results:
99149916
description: >-
9915-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
9916-
Parallel engines; ignored with native provider search.
9917+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
9918+
Parallel, and Perplexity engines; ignored with native provider search.
99179919
example: 5
99189920
type: integer
99199921
search_context_size:
@@ -17046,8 +17048,8 @@ components:
1704617048
$ref: '#/components/schemas/WebSearchDomainFilter'
1704717049
max_results:
1704817050
description: >-
17049-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
17050-
Parallel engines; ignored with native provider search.
17051+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
17052+
Parallel, and Perplexity engines; ignored with native provider search.
1705117053
example: 5
1705217054
type: integer
1705317055
search_context_size:
@@ -17072,8 +17074,8 @@ components:
1707217074
$ref: '#/components/schemas/WebSearchDomainFilter'
1707317075
max_results:
1707417076
description: >-
17075-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
17076-
Parallel engines; ignored with native provider search.
17077+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
17078+
Parallel, and Perplexity engines; ignored with native provider search.
1707717079
example: 5
1707817080
type: integer
1707917081
search_context_size:
@@ -19174,11 +19176,12 @@ components:
1917419176
type: object
1917519177
SearchQualityLevel:
1917619178
description: >-
19177-
How much context to retrieve per result. Applies to Exa and Parallel engines; ignored with native provider
19178-
search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000);
19179-
when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result).
19180-
For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default
19181-
size. Overridden by `max_characters` when both are set.
19179+
How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native
19180+
provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000,
19181+
high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters
19182+
per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own
19183+
default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden
19184+
by `max_characters` when both are set.
1918219185
enum:
1918319186
- low
1918419187
- medium
@@ -21177,33 +21180,35 @@ components:
2117721180
properties:
2117821181
allowed_domains:
2117921182
description: >-
21180-
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers
21181-
(Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains.
21183+
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native
21184+
providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains.
2118221185
items:
2118321186
type: string
2118421187
type: array
2118521188
engine:
2118621189
$ref: '#/components/schemas/WebSearchEngineEnum'
2118721190
excluded_domains:
2118821191
description: >-
21189-
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not
21190-
supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains.
21192+
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, and
21193+
xAI. Not supported with OpenAI (silently ignored). Cannot be used with allowed_domains.
2119121194
items:
2119221195
type: string
2119321196
type: array
2119421197
max_characters:
2119521198
description: >-
21196-
Exact maximum number of characters of content per search result. Applies to the Exa and Parallel engines;
21197-
ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel,
21198-
caps excerpt content per result (default 1,500 when omitted). When both `max_characters` and
21199-
`search_context_size` are set, `max_characters` takes precedence for both engines. When omitted, falls back
21200-
to `search_context_size` mapping (Exa) or engine defaults (Parallel).
21199+
Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and
21200+
Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per
21201+
result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to
21202+
the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to
21203+
the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters`
21204+
takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults
21205+
(Parallel, Perplexity).
2120121206
example: 2000
2120221207
type: integer
2120321208
max_results:
2120421209
description: >-
21205-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
21206-
Parallel engines; ignored with native provider search.
21210+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
21211+
Parallel, and Perplexity engines; ignored with native provider search.
2120721212
example: 5
2120821213
type: integer
2120921214
max_total_results:
@@ -21244,19 +21249,22 @@ components:
2124421249
- exa
2124521250
- firecrawl
2124621251
- parallel
21252+
- perplexity
2124721253
example: exa
2124821254
type: string
2124921255
WebSearchEngineEnum:
2125021256
description: >-
2125121257
Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native"
2125221258
forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires
21253-
BYOK). "parallel" uses the Parallel search API.
21259+
BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked
21260+
results).
2125421261
enum:
2125521262
- auto
2125621263
- native
2125721264
- exa
2125821265
- parallel
2125921266
- firecrawl
21267+
- perplexity
2126021268
example: auto
2126121269
type: string
2126221270
WebSearchPlugin:
@@ -21337,8 +21345,8 @@ components:
2133721345
$ref: '#/components/schemas/WebSearchDomainFilter'
2133821346
max_results:
2133921347
description: >-
21340-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
21341-
Parallel engines; ignored with native provider search.
21348+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
21349+
Parallel, and Perplexity engines; ignored with native provider search.
2134221350
example: 5
2134321351
type: integer
2134421352
search_context_size:
@@ -21376,33 +21384,35 @@ components:
2137621384
properties:
2137721385
allowed_domains:
2137821386
description: >-
21379-
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers
21380-
(Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains.
21387+
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native
21388+
providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains.
2138121389
items:
2138221390
type: string
2138321391
type: array
2138421392
engine:
2138521393
$ref: '#/components/schemas/WebSearchEngineEnum'
2138621394
excluded_domains:
2138721395
description: >-
21388-
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not
21389-
supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains.
21396+
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, and
21397+
xAI. Not supported with OpenAI (silently ignored). Cannot be used with allowed_domains.
2139021398
items:
2139121399
type: string
2139221400
type: array
2139321401
max_characters:
2139421402
description: >-
21395-
Exact maximum number of characters of content per search result. Applies to the Exa and Parallel engines;
21396-
ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel,
21397-
caps excerpt content per result (default 1,500 when omitted). When both `max_characters` and
21398-
`search_context_size` are set, `max_characters` takes precedence for both engines. When omitted, falls back
21399-
to `search_context_size` mapping (Exa) or engine defaults (Parallel).
21403+
Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and
21404+
Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per
21405+
result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to
21406+
the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to
21407+
the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters`
21408+
takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults
21409+
(Parallel, Perplexity).
2140021410
example: 2000
2140121411
type: integer
2140221412
max_results:
2140321413
description: >-
21404-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
21405-
Parallel engines; ignored with native provider search.
21414+
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
21415+
Parallel, and Perplexity engines; ignored with native provider search.
2140621416
example: 5
2140721417
type: integer
2140821418
max_total_results:

0 commit comments

Comments
 (0)