Skip to content

chore: update OpenAPI spec from monorepo #459

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
robert-j-y merged 1 commit into from
Jun 12, 2026
Merged

chore: update OpenAPI spec from monorepo #459

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
104 changes: 57 additions & 47 deletions .speakeasy/in.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5827,33 +5827,35 @@ components:
properties:
allowed_domains:
description: >-
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers
(Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains.
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native
providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains.
items:
type: string
type: array
engine:
$ref: '#/components/schemas/WebSearchEngineEnum'
excluded_domains:
description: >-
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not
supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains.
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, and
xAI. Not supported with OpenAI (silently ignored). Cannot be used with allowed_domains.
items:
type: string
type: array
max_characters:
description: >-
Exact maximum number of characters of content per search result. Applies to the Exa and Parallel engines;
ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel,
caps excerpt content per result (default 1,500 when omitted). When both `max_characters` and
`search_context_size` are set, `max_characters` takes precedence for both engines. When omitted, falls back
to `search_context_size` mapping (Exa) or engine defaults (Parallel).
Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and
Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per
result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to
the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to
the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters`
takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults
(Parallel, Perplexity).
example: 2000
type: integer
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
max_total_results:
Expand Down Expand Up @@ -9912,8 +9914,8 @@ components:
$ref: '#/components/schemas/WebSearchDomainFilter'
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
search_context_size:
Expand Down Expand Up @@ -17046,8 +17048,8 @@ components:
$ref: '#/components/schemas/WebSearchDomainFilter'
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
search_context_size:
Expand All @@ -17072,8 +17074,8 @@ components:
$ref: '#/components/schemas/WebSearchDomainFilter'
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
search_context_size:
Expand Down Expand Up @@ -19174,11 +19176,12 @@ components:
type: object
SearchQualityLevel:
description: >-
How much context to retrieve per result. Applies to Exa and Parallel engines; ignored with native provider
search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000);
when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result).
For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default
size. Overridden by `max_characters` when both are set.
How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native
provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000,
high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters
per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own
default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden
by `max_characters` when both are set.
enum:
- low
- medium
Expand Down Expand Up @@ -21177,33 +21180,35 @@ components:
properties:
allowed_domains:
description: >-
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers
(Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains.
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native
providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains.
items:
type: string
type: array
engine:
$ref: '#/components/schemas/WebSearchEngineEnum'
excluded_domains:
description: >-
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not
supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains.
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, and
xAI. Not supported with OpenAI (silently ignored). Cannot be used with allowed_domains.
items:
type: string
type: array
max_characters:
description: >-
Exact maximum number of characters of content per search result. Applies to the Exa and Parallel engines;
ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel,
caps excerpt content per result (default 1,500 when omitted). When both `max_characters` and
`search_context_size` are set, `max_characters` takes precedence for both engines. When omitted, falls back
to `search_context_size` mapping (Exa) or engine defaults (Parallel).
Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and
Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per
result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to
the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to
the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters`
takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults
(Parallel, Perplexity).
example: 2000
type: integer
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
max_total_results:
Expand Down Expand Up @@ -21244,19 +21249,22 @@ components:
- exa
- firecrawl
- parallel
- perplexity
example: exa
type: string
WebSearchEngineEnum:
description: >-
Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native"
forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires
BYOK). "parallel" uses the Parallel search API.
BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked
results).
enum:
- auto
- native
- exa
- parallel
- firecrawl
- perplexity
example: auto
type: string
WebSearchPlugin:
Expand Down Expand Up @@ -21337,8 +21345,8 @@ components:
$ref: '#/components/schemas/WebSearchDomainFilter'
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
search_context_size:
Expand Down Expand Up @@ -21376,33 +21384,35 @@ components:
properties:
allowed_domains:
description: >-
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers
(Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains.
Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native
providers (Anthropic, OpenAI, xAI). Cannot be used with excluded_domains.
items:
type: string
type: array
engine:
$ref: '#/components/schemas/WebSearchEngineEnum'
excluded_domains:
description: >-
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not
supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains.
Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, and
xAI. Not supported with OpenAI (silently ignored). Cannot be used with allowed_domains.
items:
type: string
type: array
max_characters:
description: >-
Exact maximum number of characters of content per search result. Applies to the Exa and Parallel engines;
ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel,
caps excerpt content per result (default 1,500 when omitted). When both `max_characters` and
`search_context_size` are set, `max_characters` takes precedence for both engines. When omitted, falls back
to `search_context_size` mapping (Exa) or engine defaults (Parallel).
Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and
Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per
result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to
the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to
the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters`
takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults
(Parallel, Perplexity).
example: 2000
type: integer
max_results:
description: >-
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and
Parallel engines; ignored with native provider search.
Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl,
Parallel, and Perplexity engines; ignored with native provider search.
example: 5
type: integer
max_total_results:
Expand Down
Loading