Parallel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Parallel Search API

2 actions 2 updates phrasing extends openapi/parallel-search-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Parallel's API. It is a proposal applied on top of the contract, not a document Parallel publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/search'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Parallel Search API
  version: 1.0.0
extends: openapi/parallel-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the web with keyword queries
      effect: read
      questions:
      - How do I run a web search and get back excerpts I can feed to an LLM?
      - What search modes are there, like turbo, fast, basic or advanced?
      - Can I describe the goal behind my search so the results are better targeted?
      - Is there a limit on how many characters of excerpts the web search returns?
      instructions:
      - text: Search the web for {search_queries}.
        slots:
          search_queries: requestBody.search_queries
      - text: Run a web search for {search_queries} with the goal of {objective}.
        slots:
          search_queries: requestBody.search_queries
          objective: requestBody.objective
      - text: Do a {mode} mode web search for {search_queries}.
        slots:
          mode: requestBody.mode
          search_queries: requestBody.search_queries
      method: generated
      generated: '2026-10-01'