Discover API
Discover API synchronous request
Use the Bright Data Discover API synchronous endpoint to get ranked search results in a single request with no polling, within a 60-second timeout.
POST
The Bright Data Discover API synchronous endpoint returns ranked search results in the same HTTP response, so you do not create a task or poll for results. Use the synchronous endpoint when a search completes inside the 60-second timeout budget and you need results inline, for example in an AI agent, a RAG pipeline or a chat backend.
The synchronous endpoint accepts the same request body as the asynchronous Discover API endpoint. Only the response differs: the synchronous endpoint returns the final results payload instead of a
Use the synchronous endpoint when the result feeds directly into an AI integration. An agent, a retrieval-augmented generation (RAG) pipeline or a chat backend can send one request and use the ranked results in the same turn, with no task tracking and no polling loop to build or maintain.
Use the asynchronous endpoint when a search may exceed the 60-second synchronous timeout, or when you collect results in the background and fetch them later with Retrieve Results.
The synchronous response uses the same schema as Retrieve Results. The
task_id.
Body Parameters
The search query.
Maximum length: 1,500 characters.
Describes the specific goal of the search to help the AI evaluate and rank result relevance. If not provided, the
query string is used as the intent.Maximum length: 3,000 characters.For best results, use the following formula:
Controls the search depth and ranking behavior of the request.
standard- Provides standard search depth and AI ranking. Best for general use cases where a balance of relevance and speed is needed.zeroRanking- Bypasses AI ranking to maximize the raw volume of results returned. Best when you want to collect as much broad data as possible without relevance filtering.InzeroRankingmode, thenum_resultsparameter has no effect on the number of results returned. Additionally,include_contentis not supported in this mode.deep- Performs a more exhaustive, broader search. Best when you need comprehensive coverage of a topic and prioritize thoroughness over speed.fast- Optimizes the request for quicker response times. Best for time-sensitive tasks where getting immediate results is the top priority.
A list of exact keywords that must appear in the search results. The API automatically applies
intext: operators to guarantee keyword inclusion.Example: ["Product Manager", "Roadmap"]The response format.Available options:
json, mdWhen set tomdandinclude_contentis true, the content field returns parsed Markdown instead of raw HTML.
If true, the response will include the page content in markdown format.PDF support: When a search result links to a PDF file, the API will automatically extract and parse the PDF content. Limitations:
- Maximum PDF file size: 50 MB
- Maximum PDF parsing time: 30 seconds
- If either limit is exceeded, the content field returns empty.
If true, the response will extract and include an array of images.
The language to search in and return data for.Supported across 31 languages to align with Voyage AI and SERP capabilities, including but not limited to:
en (English), es (Spanish), fr (French), de (German), zh (Chinese), ja (Japanese), ar (Arabic), he (Hebrew), ko (Korean), hi (Hindi), pt (Portuguese), and ru (Russian).The exact number of search results to return in the response.
If true, duplicate results will be removed from the response.
Search only for content updated from the date specified (format: YYYY-MM-DD).
Search only for content updated until the date specified (format: YYYY-MM-DD).
Get search results from a specific country. This accepts all standard 2-letter ISO country codes (e.g.,
US, GB, DE, IL, FR, JP). This will prioritize content from the selected country in the search results.Get search results localized to a specific city using SERP
uule encoding (e.g., "New York", "Berlin", "Tel Aviv"). For best results, use this in conjunction with the corresponding country parameter.Synchronous vs. Asynchronous
The synchronous and asynchronous Discover API endpoints take identical request bodies. They differ only in how you receive results.Synchronous (POST /discover/sync) | Asynchronous (POST /discover) | |
|---|---|---|
| Response | Final ranked results in the same HTTP response | A task_id to fetch later |
| Polling | None | Poll Retrieve Results until status is done |
| Round trips | 1 | 2 or more |
| Timeout budget | 60 seconds per request | Not bound to a single request |
| Best for | AI agents, RAG pipelines and chat backends that need results inline | Large or slow searches, batch jobs and background collection |
status field is always done because the results are final when the response returns.
The status of the request. For the synchronous endpoint this is always
done.The time taken to process the request in seconds.
A list of sorted search results.
Errors
The synchronous endpoint carries over the validation and authentication errors from the asynchronous Discover API endpoint, and adds a504 error when a search does not finish within the 60-second timeout budget.
| Status | Error Message | Trigger | Resolution |
|---|---|---|---|
| 400 | {"error":"Missing query"} | query is missing, empty, or null | Provide a non-empty string in the query field. |
| 400 | {"error":"Invalid query. Max length is 1500 chars"} | query exceeds 1,500 characters, or is a non-string type (number, array) | Provide a string of 1,500 characters or fewer. |
| 400 | {"error":"Invalid intent. Max length is 3000 chars"} | intent exceeds 3,000 characters, or is a non-string type | Provide a string of 3,000 characters or fewer, or omit to use query as the intent. |
| 400 | {"error":"Unsupported format. Only \"md\" and \"json\" are supported"} | format is not “json” or “md” (e.g. “markdown”, “xml”, “csv”, empty string, or non-string type) | Set format to “json” or “md”. |
| 400 | {"error":"Invalid num_results. Must be a number between 1 and 20"} | num_results is 0, negative, greater than 20, or a non-number type | Provide an integer between 1 and 20. |
| 400 | {"error":"Invalid filter_keywords. Must be an array of strings"} | filter_keywords is not an array (e.g. a string) | Provide an array of strings, e.g. [“keyword1”, “keyword2”]. |
| 400 | {"error":"Invalid start_date"} | start_date is not in YYYY-MM-DD format, is a non-string type, is in the future, or start_date > end_date | Provide a valid past or present date in YYYY-MM-DD format. |
| 400 | {"error":"Invalid end_date"} | end_date is not in YYYY-MM-DD format or is a non-string type | Provide a valid date in YYYY-MM-DD format. |
| 400 | {"error":"Unsupported country"} | country is a string but not a valid ISO 3166-1 alpha-2 code | Use a valid 2-letter country code (e.g. “US”, “IL”, “DE”). |
| 400 | {"error":"Unexpected fields: <field_names>"} | Request body contains unrecognized field names | Remove unexpected fields. Only use documented parameters. |
| 401 | Credentials are missing | No Authorization header provided | Add Authorization: Bearer <token> header. |
| 401 | Invalid credentials | Token in Authorization header is invalid | Provide a valid API token. |
| 401 | Auth method is not supported | Authorization header is missing the Bearer prefix | Use the format Authorization: Bearer <token>. |
| 403 | Forbidden | Discover API is not enabled for your account | Contact your account manager to enable the Discover API. |
| 429 | Too Many Requests | Rate or concurrency limit exceeded | Slow down requests or upgrade your plan. |
| 500 | Internal Server Error | Server-side issue | Retry after a few seconds. |
| 504 | {"error":"Request timed out"} | The search did not complete within the 60-second synchronous timeout budget | Narrow the query, reduce num_results, or use the asynchronous Discover API endpoint and poll Retrieve Results. |
FAQs
What happens when a synchronous request times out?
What happens when a synchronous request times out?
When a search does not complete within the 60-second timeout budget, the synchronous endpoint returns a
504 error and no results. Retry with a narrower query or a smaller num_results, or send the same request body to the asynchronous Discover API endpoint and fetch the results later with Retrieve Results.Does a timeout return partial results?
Does a timeout return partial results?
No. The synchronous endpoint does not return partial results. A request either returns the complete ranked results with a
200 status, or it returns a 504 error with no results.Is the synchronous response schema the same as Retrieve Results?
Is the synchronous response schema the same as Retrieve Results?
Yes. The synchronous endpoint returns the same payload schema as Retrieve Results: a
status field, a duration_seconds field and a results array. The only difference is that status is always done, because the results are final when the response returns.When should I use the synchronous endpoint instead of the asynchronous one?
When should I use the synchronous endpoint instead of the asynchronous one?
Use the synchronous endpoint when the result feeds directly into an AI integration such as an agent, a RAG pipeline or a chat backend, and the search completes within 60 seconds. Use the asynchronous endpoint for large or slow searches, batch jobs and background collection.
Why am I getting a 403 Forbidden error?
Why am I getting a 403 Forbidden error?
Access to the Bright Data Discover API is restricted. It must be manually enabled for your account by your account manager.