Skip to main content
POST
/
v1
/
search
Python
from parallel import Parallel

client = Parallel()

search = client.search(
    objective="Find latest information about Parallel Web Systems. Focus on new product releases, benchmarks, or company announcements.",
    search_queries=["Parallel Web Systems products", "Parallel Web Systems announcements"],
)
print(search.results)
{
  "search_id": "search_fcb2b4f3c75e418687bccaa1a8381331",
  "results": [
    {
      "url": "https://www.example.com",
      "title": "Sample webpage title",
      "publish_date": "2024-01-15",
      "excerpts": [
        "Sample excerpt 1",
        "Sample excerpt 2"
      ]
    }
  ],
  "session_id": "session_fcb2b4f3c75e418687bccaa1a8381331"
}

Documentation Index

Fetch the complete documentation index at: https://docs.parallel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json

Search request.

​
search_queries
string[]
required

Concise keyword search queries, 3-6 words each. At least one query is required, provide 2-3 for best results. Used together with objective to focus results on the most relevant content.

​
objective
string | null

Natural-language description of the underlying question or goal driving the search. Used together with search_queries to focus results on the most relevant content. Should be self-contained with enough context to understand the intent of the search.

​
mode
enum<string> | null

Search mode preset: supported values are basic and advanced. Basic mode offers the lowest latency and works best with 2-3 high-quality search_queries. Advanced mode provides higher quality with more advanced retrieval and compression. Defaults to advanced when omitted.

Available options:
basic,
advanced
​
max_chars_total
integer | null

Upper bound on total characters across excerpts from all results.

​
session_id
string | null

Session identifier to track calls across separate search and extract calls, to be used as part of a larger task. Specifying it may give better contextual results for subsequent API calls.

Maximum string length: 1000
​
client_model
string | null

The model generating this request and consuming the results. Enables optimizations and tailors default settings for the model's capabilities.

Example:

"claude-opus-4-7"

​
advanced_settings
AdvancedSearchSettings · object

Advanced configuration for source policy, fetch policy, and excerpt settings. May impact result quality and latency unless used carefully. When omitted, excerpts are enabled by default.

Response

Successful Response

Search response.

​
search_id
string
required

Search ID. Example: search_cad0a6d2dec046bd95ae900527d880e7

​
results
V1WebSearchResult · object[]
required

A list of search results, ordered by decreasing relevance.

​
session_id
string
required

Session identifier, echoed back from the request if provided, otherwise generated by the server. Should be passed to future search and extract calls made by the agent as part of the same larger task.

Example:

"session_8a911eb27c7a4afaa20d0d9dc98d07c0"

​
warnings
Warning · object[] | null

Warnings for the search request, if any.

​
usage
UsageItem · object[] | null

Usage metrics for the search request.