Skip to main content
timeoutOpts sets the API’s processing deadline. A client timeout controls how long your application waits for the response; configure both.

Request deadline

For JSON endpoints, send:
GET endpoints accept timeoutOpts[milliseconds]=30000 and timeoutOpts[behavior]=return-partial, or a JSON-encoded timeoutOpts value. Use the endpoint reference for its minimum; the maximum is 300,000 ms. Most endpoints use partial: true. Scrape uses isPartial and per-output success; Scrape deadlines describe its output-level failures. Prefetch supports only fail.

Endpoint limits

Scrape defaults to 60 seconds, and return-partial needs at least five seconds. Fixed waits must leave room to return the response. An uncached Brand domain/email lookup with fail and less than ten seconds returns 422 COLD_DOMAIN_TIMEOUT_TOO_LOW. Use a longer budget, partial results, or prefetch. Answers deadlines can shorten but cannot extend the selected research budget. Crawl also has a soft stopAfterMs budget. Neither setting replaces the overall request deadline.

Client timeout and retries

Keep the client timeout longer than the API deadline plus network overhead. SDK timeout and retry defaults are listed on SDKs. A timed-out client can retry while the earlier request is still running; review retries for expensive or long tasks. Scrape observes client disconnects. Other work may continue after your client stops waiting. For durable long-running jobs, use Batches and poll their status. Do not cache a partial response as a complete result. Save its completion flag with the data and retry missing work when your product needs it.