Get started with Orbit v3

This quickstart finds machine learning engineers in San Francisco, asks Orbit to discover additional candidates, and returns partial profiles directly in the results.

Create an API key

Open the developer dashboard and create a key with search:read and profile:read.

export ORBIT_API_KEY="sk_orb_REDACTED"

Orbit shows the raw key once. Store it in a secrets manager before closing the dashboard modal.

Start a Search

curl -X POST "https://api.orbitsearch.com/v3/search" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "quickstart-search-001",
    "intent": {
      "experiences": [{ "title": "Machine Learning Engineer" }],
      "geo": { "place": "San Francisco" }
    },
    "candidate_discovery": true,
    "profile_depth": "partial",
    "include_profile": true,
    "limit": 10
  }'

Save both IDs from the response:

{
  "search_id": "3e26d3b8-76aa-4be2-8d43-ef6a6d8895cb",
  "request_id": "quickstart-search-001",
  "status": "running",
  "results": [],
  "links": {
    "status": "/v3/search/3e26d3b8-76aa-4be2-8d43-ef6a6d8895cb"
  }
}

request_id makes POST retries idempotent. search_id identifies the pollable Search resource.

Poll until terminal

curl "https://api.orbitsearch.com/v3/search/3e26d3b8-76aa-4be2-8d43-ef6a6d8895cb" \
  -H "Authorization: Bearer $ORBIT_API_KEY"

Continue while status is running. Stop on completed, completed_with_errors, or failed.

Use ready profiles

{
  "status": "completed",
  "results": [
    {
      "profile_id": "profile_123",
      "status": "ready",
      "generation_level": 2,
      "profile": {
        "id": "profile_123",
        "displayName": "Example Person",
        "generationLevel": 2
      }
    }
  ]
}

Keep ready results. If the search finishes as completed_with_errors, inspect each failed result separately without discarding successful profiles.

Next steps

Review the three Search controls.
See every supported structured intent field.
Upgrade a result to full with Enrich.
Add production retry behavior from Error handling.

Start here

Concepts

Guides

Updates

Get started with Orbit v3

Next steps

​Next steps

Next steps