Skip to main content
This example starts one Search, honors Retry-After, polls with backoff, and preserves ready results when some candidates fail.

Request

Orbit creates the internal request ID automatically. Persist the returned search_id; it is the handle used for every later poll. Applications that require safe POST retries after a lost response can additionally send an optional Idempotency-Key header.

Poll

Consume Results

completed_with_errors is a usable partial success. Keep the ready profiles and decide whether each failed result warrants a new logical request. Each ready profile carries the person’s identity and contact fields and generated sections, such as bio, jobs, and education. For the image gallery and source links, call Read a profile with its profile_id. That explicit read uses the profile-read credit rate.

Production Checklist

  • Use a key with search:read and, when embedding profiles, profile:read.
  • Persist search_id with your job record.
  • Put a client-side deadline around polling, but do not start duplicate work when it expires.
  • Honor Retry-After on 429 responses.
  • Log the Search ID, terminal status, and failure codes.
  • Set include_profile: false when a downstream worker only needs IDs.
See Error handling for the complete retry policy.