Submit a list of searches once, then poll one job. Orbit queues the work and retries temporary processing failures automatically. You do not need to send or retry a separate HTTP request for every CSV row.Requires search:read. Items with include_profile: true also require profile:read when submitting and reading results.
Each item has a unique id and the fields from Search, except request_id. Put request_id on the whole job. Face searches use the individual Search endpoint.
Submit and Retry
A successful submission returns 202 with job_id, request_id, status, counts, billing, and links to status, results, and cancellation.Keep the same request_id when retrying submission. With the same API key, normalized items, and search-session context, it returns the original job. Changing the items or adding, removing, or changing the signed-in session under that identity returns 409 bulk_search_idempotency_conflict.Limits:
1–5,000 items per job and an 8 MiB request body.
At most 32 KiB per item.
request_id and item id values must contain 1–128 characters.
At most four unfinished jobs per billing account.
A full queue returns 409 bulk_search_queue_full with Retry-After. Retry the same job identity after the indicated delay. An accepted job does not consume the individual Search request-rate allowance for every item.Submission and cancellation each allow a burst of eight HTTP requests per API key, refilling at one request every two seconds. Status and results share a separate bucket with a burst of 30, refilling at five requests per second. Excessive requests return 429 with Retry-After; accepted jobs keep processing. These buckets are separate from individual Search.When submitting with an authenticated search session, use the same signed-in person for status, results, cancellation, and idempotent replay. Directory access is checked again during processing and result reads.
Track Progress
GET /v3/search/bulk/{job_id}
Poll about every three seconds. Job statuses are queued, running, waiting_for_credits, needs_attention, completed, completed_with_errors, and canceled.counts includes total, completed, failed, canceled, and pending. Failed counts include items that completed with some errors. An empty successful search is completed; it is not a processing failure.Temporary errors appear in last_error while the job retries. If the job enters waiting_for_credits, add credits to the same billing account. It resumes automatically.After repeated recovery failures, needs_attention asks you to contact support with the job id. Automatic recovery continues about every five minutes. Started work and its reserved credits remain tracked until their outcome is established.
Read Results
GET /v3/search/bulk/{job_id}/results?offset=0
Each page contains at most ten items and a next_offset. The offset follows the original input order, including unfinished items. Revisit unfinished pages after the job advances.Each item includes:
id: your original item id.
index: its zero-based position.
status: queued, processing, completed, completed_with_errors, failed, or canceled.
result: a search snapshot, or null until its results are ready to publish.
Use the result’s status link to return to that item’s bulk results page. Its internal search identifier does not create an independently pollable Search resource. Search confidence, candidate-discovery behavior, and profile depth have the same meanings as in an individual search.Results become available in small groups after their billing completes. A slow item can delay publication of the other items in its group.
Billing and Cancellation
Credits are reserved as groups of items begin processing. Orbit charges for the results under the pricing rules and releases unused credits. Retrying a job or reading its saved results does not repeat its search charges. Different item ids represent separate searches, even if their inputs are identical.
POST /v3/search/bulk/{job_id}/cancel
Cancellation skips undispatched items. Work that already started finishes reconciling and billing, so cancellation can remain pending while that work completes. Published results stay available.
Authorizations
Authorization
string
header
required
Use an Orbit API key from the Developer Dashboard.
Body
application/json
request_id
string
required
Required string length: 1 - 128
items
object[]
required
Required array length: 1 - 5000 elements
Provide query, intent, at least one identity signal, or a supported combination. When query and intent are both present, Orbit derives a base intent from query and overlays the caller-provided intent. Arrays, scalar values, and null replace derived values; nested objects merge field by field.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Orbit Developer API","description":"Find people with search, look deeper with enrich, and stay up to date with watchers.","colors":{"primary":"#0875B9","light":"#3AB3FF","dark":"#0875B9"},"logo":{"light":"https://mintcdn.com/orbit-5c173338/k-iXLNt-i1YvMS-Z/assets/orbit-logo-mark.png?fit=max\u0026auto=format\u0026n=k-iXLNt-i1YvMS-Z\u0026q=85\u0026s=8b0d9a458f0dbb073a9c9e109b9057bb","dark":"https://mintcdn.com/orbit-5c173338/k-iXLNt-i1YvMS-Z/assets/orbit-logo-mark.png?fit=max\u0026auto=format\u0026n=k-iXLNt-i1YvMS-Z\u0026q=85\u0026s=8b0d9a458f0dbb073a9c9e109b9057bb","href":"https://developer.orbitsearch.com"},"favicon":"https://mintcdn.com/orbit-5c173338/OymEY6nP8OtkVM8Z/assets/icon.png?fit=max\u0026auto=format\u0026n=OymEY6nP8OtkVM8Z\u0026q=85\u0026s=505a66363f63b13b3eb495e4da1c65ff","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]},"mdx":{"auth":{"method":"bearer"},"server":"https://api.orbitsearch.com"}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FAFAFA","dark":"#00050E"}},"navbar":{"links":[{"href":"https://orbitsearch.com","label":"Website"},{"href":"https://developer.orbitsearch.com/dashboard","label":"Developer Dashboard"},{"href":"https://github.com/orbit-search","type":"github"}],"primary":{"type":"button","label":"Get API Key","href":"https://developer.orbitsearch.com/auth/signup?next=%2Fdashboard%2Fkeys"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","download-spec"],"display":"header"},"metadata":{"timestamp":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orbit-5c173338","hasAudioNarration":false,"actualSubdomain":"orbit-5c173338","customDomains":["docs.orbitsearch.com"],"gitSource":{"type":"github","owner":"orbit-search","repo":"docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af2664fa30fe9d37b3354dc","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Reference","count":29},{"language":"default","tag":"Documentation","count":18},{"language":"default","tag":"Search","count":8},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Watchers","count":6},{"language":"default","tag":"Start Here","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"Keys","count":4},{"language":"default","tag":"Enrich","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20300.woff2\") format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20500.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20700.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20900.woff2\") format(\"woff2\");font-weight:900;font-style:normal;font-display:swap}:root{--orbit-ink-50: #fafafa;--orbit-ink-100: #f4f4f5;--orbit-ink-300: #c9c9ce;--orbit-ink-400: #9a9aa2;--orbit-ink-600: #2a3a58;--orbit-ink-700: #18273f;--orbit-ink-800: #0c1623;--orbit-ink-900: #060d1d;--orbit-ink-950: #040914;--orbit-cyan: #70ebff;--orbit-lavender: #d9bdf2;--orbit-orchid: #9b5bff;--orbit-indigo: #4869ff;--orbit-violet: #8901fe;--orbit-pink: #ff0055;--orbit-top-gradient: linear-gradient(\n 90deg,\n #ff0055 0%,\n #e00181 25%,\n #8901fe 48%,\n #6d2eff 74%,\n #4869ff 100%\n );--orbit-background: #fafafa;--orbit-foreground: #101828;--orbit-text: #344054;--orbit-muted: #475467;--orbit-surface: rgba(16, 24, 40, 0.035);--orbit-surface-strong: rgba(16, 24, 40, 0.065);--orbit-border: rgba(16, 24, 40, 0.12);--orbit-border-strong: rgba(16, 24, 40, 0.2);--orbit-navbar: rgba(250, 250, 250, 0.9);--orbit-sidebar: rgba(250, 250, 250, 0.95);--orbit-footer: rgba(244, 244, 245, 0.8);--orbit-link: #0875b9;--orbit-link-hover: #065b91;--orbit-link-underline: rgba(8, 117, 185, 0.45);--orbit-accent-border: rgba(109, 46, 255, 0.22);--orbit-accent-border-hover: rgba(109, 46, 255, 0.4);--orbit-accent-surface: rgba(109, 46, 255, 0.06);--orbit-shadow: rgba(16, 24, 40, 0.18);--orbit-cta-background: #101828;--orbit-cta-text: #fafafa}html.dark{--orbit-background: #00050e;--orbit-foreground: #fafafa;--orbit-text: rgba(244, 244, 245, 0.78);--orbit-muted: rgba(250, 250, 250, 0.65);--orbit-surface: rgba(255, 255, 255, 0.055);--orbit-surface-strong: rgba(255, 255, 255, 0.09);--orbit-border: rgba(255, 255, 255, 0.12);--orbit-border-strong: rgba(255, 255, 255, 0.18);--orbit-navbar: rgba(0, 5, 14, 0.68);--orbit-sidebar: rgba(0, 5, 14, 0.5);--orbit-footer: rgba(4, 9, 20, 0.42);--orbit-link: #3ab3ff;--orbit-link-hover: #70ebff;--orbit-link-underline: rgba(58, 179, 255, 0.45);--orbit-accent-border: rgba(217, 189, 242, 0.16);--orbit-accent-border-hover: rgba(217, 189, 242, 0.34);--orbit-accent-surface: rgba(155, 91, 255, 0.1);--orbit-shadow: rgba(0, 0, 0, 0.75);--orbit-cta-background: #fafafa;--orbit-cta-text: #040914}html,body,button,input,textarea,select{font-family:\"MuseoSans\", ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif}html{background:var(--orbit-background)}body{color:var(--orbit-foreground);background:var(--orbit-background);font-feature-settings:\"ss01\", \"cv11\";-webkit-font-smoothing:antialiased;text-rendering:optimizeLegibility}::selection{background:var(--orbit-foreground);color:var(--orbit-background)}#background-color{background:transparent}#navbar{border-bottom:none;background:var(--orbit-navbar);box-shadow:none;backdrop-filter:blur(18px)}#navbar>.z-10.absolute,#navbar>.z-0.absolute{display:none!important}#navbar .px-0{padding-left:0!important;padding-right:0!important}#navbar .h-12{height:64px!important;padding-left:24px!important;padding-right:24px!important;gap:32px!important}#navbar .h-12>.flex-1:first-child{flex:0 0 auto!important;gap:0!important;padding-right:0!important}#navbar .h-12>.flex-1:first-child>div{display:none!important}#navbar .h-12>.flex-1:first-child~nav{padding:0!important}#navbar .topbar-right-container{flex:1 1 auto!important;justify-content:flex-end!important;gap:12px!important}#search-bar-entry-mobile{display:none!important}#navbar button[aria-label=\"More actions\"]{display:none!important}#navbar .topbar-right-container ul{display:flex!important}#navbar .topbar-right-container .navbar-link{display:flex!important}#navbar::before{content:\"\";position:fixed;top:0;left:0;right:0;z-index:9999;height:3px;background:var(--orbit-top-gradient);pointer-events:none}.nav-logo,.nav-logo *{max-height:36px!important;height:36px!important}.nav-logo img,.nav-logo svg{height:36px!important;width:36px!important;max-height:36px!important;object-fit:contain}#navbar img[alt],#navbar a[href]>img{height:36px!important;width:36px!important;max-height:36px!important;object-fit:contain}#navbar .pb-px{padding-bottom:0!important}navbar-link,nav-tabs-item,nav-anchor,.navbar-link>a,#navbar .link{border-radius:8px;color:var(--orbit-text);font-size:15px;font-weight:500;gap:32px;transition:color 180ms ease,\n background-color 180ms ease,\n transform 180ms ease}#navbar .h-12>nav .link{height:36px!important;padding-left:14px!important;padding-right:14px!important;border-radius:8px!important}navbar-link:hover,nav-tabs-item:hover,nav-anchor:hover,.navbar-link>a:hover,#navbar .link:hover,nav-tabs-item[data-active],.nav-tabs-item[data-active]{color:var(--orbit-foreground);background:var(--orbit-surface-strong);transform:translateY(-1px)}#topbar-cta-button>a{border:none;background:var(--orbit-cta-background);color:var(--orbit-cta-text);border-radius:999px;font-weight:700;box-shadow:none;transition:transform 180ms ease,\n opacity 180ms ease}#topbar-cta-button>a span{color:var(--orbit-cta-text)}#topbar-cta-button>a:hover{opacity:0.85;transform:translateY(-1px)}#search-bar-entry,#search-bar-entry-mobile{border:1px solid var(--orbit-border);background:var(--orbit-surface-strong);color:var(--orbit-text)}#search-bar-entry:hover,#search-bar-entry-mobile:hover{border-color:var(--orbit-accent-border-hover);background:var(--orbit-accent-surface);color:var(--orbit-foreground)}#sidebar,#table-of-contents{border-color:var(--orbit-border);background:var(--orbit-sidebar);backdrop-filter:blur(16px)}#navigation-items,#table-of-contents-content{padding-top:40px!important}#navigation-items .mt-6,#navigation-items .lg\\:mt-8{margin-top:16px!important}#sidebar-content li[data-active]{border-radius:8px;background:rgba(58, 179, 255, 0.16)}#sidebar-content li[data-active] a,toc-item[data-active],toc-item[data-active-deepest]{color:var(--orbit-link)}#page-title{color:var(--orbit-foreground);letter-spacing:0}eyebrow,breadcrumb-list,#table-of-contents-content{color:var(--orbit-muted)}mdx-content{color:var(--orbit-text)}mdx-content h2,mdx-content h3,mdx-content h4{color:var(--orbit-foreground);letter-spacing:0}mdx-content a,link{color:var(--orbit-link);text-underline-offset:0.18em}#content-area a.link{background:none!important;border:none!important;border-radius:0!important;box-shadow:none!important;padding:0!important;color:var(--orbit-link);font-weight:500;text-decoration:underline;text-decoration-thickness:1px;text-decoration-color:var(--orbit-link-underline);text-underline-offset:0.2em}#content-area a.link:hover{color:var(--orbit-link-hover);text-decoration-color:var(--orbit-link-hover)}card,callout,accordion,expandable,tabs,code-block,#request-example,#response-example,#api-playground-input{border-color:var(--orbit-accent-border);background:var(--orbit-surface);box-shadow:0 18px 60px -42px var(--orbit-shadow);backdrop-filter:blur(12px)}card:hover{border-color:var(--orbit-accent-border-hover);background:var(--orbit-accent-surface)}code-block{background:rgba(4, 9, 20, 0.94)}method-pill,method-nav-pill{border-radius:999px;font-weight:700}#pagination{border-color:var(--orbit-border)}footer,#footer{border-top:1px solid var(--orbit-border);background:var(--orbit-footer)}@media (max-width: 1023px){#navbar div.hidden.lg\\:flex.h-12{display:contents!important}#navbar div.hidden.lg\\:flex.h-12>.flex-1:first-child,#navbar div.hidden.lg\\:flex.h-12>nav{display:none!important}#navbar .topbar-right-container{position:fixed!important;top:3px!important;right:56px!important;height:69px!important;z-index:45!important;display:flex!important;align-items:center!important;gap:6px!important}#navbar .topbar-right-container>div:first-child{display:none!important}#navbar .topbar-right-container ul{display:flex!important;flex-direction:row!important;align-items:center!important;gap:10px!important;list-style:none!important}#navbar .topbar-right-container .navbar-link{display:flex!important;flex-shrink:0!important}#navbar .topbar-right-container .navbar-link a{display:block!important;width:34px!important;height:34px!important;min-width:34px!important;min-height:34px!important;padding:0!important;border:none!important;border-radius:10px!important;font-size:0!important;line-height:0!important;text-indent:-9999px!important;color:transparent!important;background:var(--orbit-surface-strong)!important;position:relative!important;overflow:hidden!important}#navbar .topbar-right-container .navbar-link a::before{content:\"\"!important;position:absolute!important;top:50%!important;left:50%!important;transform:translate(-50%, -50%)!important;width:15px!important;height:15px!important;background:var(--orbit-muted)!important;-webkit-mask-size:contain!important;mask-size:contain!important;-webkit-mask-repeat:no-repeat!important;mask-repeat:no-repeat!important;-webkit-mask-position:center!important;mask-position:center!important}#navbar .topbar-right-container .navbar-link:first-child a::before{-webkit-mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='12' cy='12' r='10'/%3E%3Cpath d='M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20'/%3E%3Cpath d='M2 12h20'/%3E%3C/svg%3E\")!important;mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='12' cy='12' r='10'/%3E%3Cpath d='M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20'/%3E%3Cpath d='M2 12h20'/%3E%3C/svg%3E\")!important}#navbar .topbar-right-container .navbar-link:nth-child(2) a::before{-webkit-mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect width='7' height='9' x='3' y='3' rx='1'/%3E%3Crect width='7' height='5' x='14' y='3' rx='1'/%3E%3Crect width='7' height='9' x='14' y='12' rx='1'/%3E%3Crect width='7' height='5' x='3' y='16' rx='1'/%3E%3C/svg%3E\")!important;mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect width='7' height='9' x='3' y='3' rx='1'/%3E%3Crect width='7' height='5' x='14' y='3' rx='1'/%3E%3Crect width='7' height='9' x='14' y='12' rx='1'/%3E%3Crect width='7' height='5' x='3' y='16' rx='1'/%3E%3C/svg%3E\")!important}#topbar-cta-button{display:flex!important}#topbar-cta-button>a{width:34px!important;height:34px!important;padding:0!important;justify-content:center!important;border-radius:50%!important;position:relative!important;overflow:hidden!important}#topbar-cta-button>a .flex{font-size:0!important;color:transparent!important}#topbar-cta-button>a .flex::before{content:\"\"!important;position:absolute!important;top:50%!important;left:50%!important;transform:translate(-50%, -50%)!important;width:18px!important;height:18px!important;background:var(--orbit-cta-text)!important;-webkit-mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23000' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='m15.5 7.5 2.3 2.3a1 1 0 0 0 1.4 0l2.1-2.1a1 1 0 0 0 0-1.4L19 4'/%3E%3Cpath d='m21 2-9.6 9.6'/%3E%3Ccircle cx='7.5' cy='15.5' r='5.5'/%3E%3C/svg%3E\")!important;mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23000' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='m15.5 7.5 2.3 2.3a1 1 0 0 0 1.4 0l2.1-2.1a1 1 0 0 0 0-1.4L19 4'/%3E%3Cpath d='m21 2-9.6 9.6'/%3E%3Ccircle cx='7.5' cy='15.5' r='5.5'/%3E%3C/svg%3E\")!important;-webkit-mask-size:contain!important;mask-size:contain!important;-webkit-mask-repeat:no-repeat!important;mask-repeat:no-repeat!important}#topbar-cta-button>a span{display:none!important}#topbar-cta-button>a svg{display:none!important}#navbar button[aria-label=\"More actions\"]{display:none!important}}@media (max-width: 1023px){#content-area{padding-top:0!important}}@media (max-width: 1023px){#navbar div.lg\\:hidden.h-12{height:70px!important;padding-left:16px!important;padding-right:60px!important}#navbar~button.h-14,button.h-14.lg\\:hidden{position:fixed!important;top:3px!important;right:16px!important;left:auto!important;width:36px!important;height:69px!important;padding:2px!important;display:flex!important;align-items:center!important;justify-content:center!important;z-index:50!important;background:transparent!important}button.h-14.lg\\:hidden>.ml-4{display:none!important}button.h-14.lg\\:hidden>div:first-child{color:var(--orbit-muted)!important}button.h-14.lg\\:hidden>div:first-child svg{height:16px!important;width:20px!important}#navigation-items{padding-top:2px!important}#sidebar,#mobile-nav,#sidebar-content{background:var(--orbit-sidebar)!important;backdrop-filter:blur(18px)!important;border-color:var(--orbit-border)!important}#sidebar-content{top:70px!important;left:0!important;right:0!important;width:100%!important;max-height:calc(100vh - 70px)!important;border-radius:0 0 16px 16px!important;border-top:none!important;border-bottom:1px solid var(--orbit-border)!important;box-shadow:0 24px 80px -40px var(--orbit-shadow)!important}}.update [data-component-part=\"update-tag-list\"],.update [data-component-part=\"update-description\"]{margin-top:0.3rem}.update [data-component-part=\"update-content\"]>:first-child strong{color:var(--orbit-foreground);display:inline-block;font-size:1.25rem;line-height:1.3;margin-bottom:0.35rem}.mdx-content:has(.update) h2{margin-top:3.25rem;padding-bottom:0.65rem;border-bottom:1px solid var(--orbit-border)}@media (min-width: 1024px){#content-container:not(:has(#content-side-layout .code-group,#request-example,#response-example,#response-examples)) #content-area{max-width:56rem;margin-left:max(0px, calc(50vw - 28rem - 14rem))}}#page-context-menu button{border-color:var(--orbit-border-strong)}#page-context-menu button[aria-haspopup] svg{color:var(--orbit-muted)}@media (prefers-reduced-motion: reduce){*,*::before,*::after{animation-duration:0.001ms!important;animation-iteration-count:1!important;scroll-behavior:auto!important;transition-duration:0.001ms!important}}#content-area:has(>#footer){display:flex;flex-direction:column;min-height:calc(100dvh - 4rem)}#content-area>#footer{margin-top:auto;padding-top:1.5rem;padding-bottom:1.5rem;background:transparent}@media (max-width: 1023px){#content-area:has(>#footer){min-height:calc(100dvh - 6.5rem)}}"}],"page":{"pagePath":"api/search/bulk-search","slug":"/api/search/bulk-search","pageMetadata":{"title":"Bulk Search","sidebarTitle":"Bulk Search","description":"Submit many searches as one resumable job.","openapi":"openapi.json POST /v3/search/bulk","href":"/api/search/bulk-search"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Submit many searches as one resumable job.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Submit a list of searches once, then poll one job. Orbit queues the work and retries temporary processing failures automatically. You do not need to send or retry a separate HTTP request for every CSV row.`}),`\n`,_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`search:read`}),`. Items with `,_jsx(_components.code,{children:`include_profile: true`}),` also require `,_jsx(_components.code,{children:`profile:read`}),` when submitting and reading results.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`17`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.orbitsearch.com/v3/search/bulk\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBIT_API_KEY`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"request_id\": \"contacts-import-2026-09-15\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"items\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"id\": \"csv-row-2\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"signals\": { \"email\": \"person@example.com\" },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"limit\": 1,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"candidate_discovery\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"candidate_discovery_limit\": 1,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"profile_depth\": \"partial\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"include_profile\": false`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Each item has a unique `,_jsx(_components.code,{children:`id`}),` and the fields from `,_jsx(_components.a,{href:`/api/search/search`,children:`Search`}),`, except `,_jsx(_components.code,{children:`request_id`}),`. Put `,_jsx(_components.code,{children:`request_id`}),` on the whole job. Face searches use the individual Search endpoint.`]}),`\n`,_jsx(Heading,{level:`2`,id:`submit-and-retry`,children:`Submit and Retry`}),`\n`,_jsxs(_components.p,{children:[`A successful submission returns `,_jsx(_components.code,{children:`202`}),` with `,_jsx(_components.code,{children:`job_id`}),`, `,_jsx(_components.code,{children:`request_id`}),`, `,_jsx(_components.code,{children:`status`}),`, `,_jsx(_components.code,{children:`counts`}),`, `,_jsx(_components.code,{children:`billing`}),`, and links to status, results, and cancellation.`]}),`\n`,_jsxs(_components.p,{children:[`Keep the same `,_jsx(_components.code,{children:`request_id`}),` when retrying submission. With the same API key, normalized items, and search-session context, it returns the original job. Changing the items or adding, removing, or changing the signed-in session under that identity returns `,_jsx(_components.code,{children:`409 bulk_search_idempotency_conflict`}),`.`]}),`\n`,_jsx(_components.p,{children:`Limits:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`1–5,000 items per job and an 8 MiB request body.`}),`\n`,_jsx(_components.li,{children:`At most 32 KiB per item.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`request_id`}),` and item `,_jsx(_components.code,{children:`id`}),` values must contain 1–128 characters.`]}),`\n`,_jsx(_components.li,{children:`At most four unfinished jobs per billing account.`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`A full queue returns `,_jsx(_components.code,{children:`409 bulk_search_queue_full`}),` with `,_jsx(_components.code,{children:`Retry-After`}),`. Retry the same job identity after the indicated delay. An accepted job does not consume the individual Search request-rate allowance for every item.`]}),`\n`,_jsxs(_components.p,{children:[`Submission and cancellation each allow a burst of eight HTTP requests per API key, refilling at one request every two seconds. Status and results share a separate bucket with a burst of 30, refilling at five requests per second. Excessive requests return `,_jsx(_components.code,{children:`429`}),` with `,_jsx(_components.code,{children:`Retry-After`}),`; accepted jobs keep processing. These buckets are separate from individual Search.`]}),`\n`,_jsx(_components.p,{children:`When submitting with an authenticated search session, use the same signed-in person for status, results, cancellation, and idempotent replay. Directory access is checked again during processing and result reads.`}),`\n`,_jsx(Heading,{level:`2`,id:`track-progress`,children:`Track Progress`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` /v3/search/bulk/{job_id}`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Poll about every three seconds. Job statuses are `,_jsx(_components.code,{children:`queued`}),`, `,_jsx(_components.code,{children:`running`}),`, `,_jsx(_components.code,{children:`waiting_for_credits`}),`, `,_jsx(_components.code,{children:`needs_attention`}),`, `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`completed_with_errors`}),`, and `,_jsx(_components.code,{children:`canceled`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`counts`}),` includes `,_jsx(_components.code,{children:`total`}),`, `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`failed`}),`, `,_jsx(_components.code,{children:`canceled`}),`, and `,_jsx(_components.code,{children:`pending`}),`. Failed counts include items that completed with some errors. An empty successful search is completed; it is not a processing failure.`]}),`\n`,_jsxs(_components.p,{children:[`Temporary errors appear in `,_jsx(_components.code,{children:`last_error`}),` while the job retries. If the job enters `,_jsx(_components.code,{children:`waiting_for_credits`}),`, add credits to the same billing account. It resumes automatically.`]}),`\n`,_jsxs(_components.p,{children:[`After repeated recovery failures, `,_jsx(_components.code,{children:`needs_attention`}),` asks you to contact support with the job id. Automatic recovery continues about every five minutes. Started work and its reserved credits remain tracked until their outcome is established.`]}),`\n`,_jsx(Heading,{level:`2`,id:`read-results`,children:`Read Results`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` /v3/search/bulk/{job_id}/results?offset=0`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Each page contains at most ten items and a `,_jsx(_components.code,{children:`next_offset`}),`. The offset follows the original input order, including unfinished items. Revisit unfinished pages after the job advances.`]}),`\n`,_jsx(_components.p,{children:`Each item includes:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`id`}),`: your original item id.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`index`}),`: its zero-based position.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),`: `,_jsx(_components.code,{children:`queued`}),`, `,_jsx(_components.code,{children:`processing`}),`, `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`completed_with_errors`}),`, `,_jsx(_components.code,{children:`failed`}),`, or `,_jsx(_components.code,{children:`canceled`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`result`}),`: a search snapshot, or `,_jsx(_components.code,{children:`null`}),` until its results are ready to publish.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Use the result’s status link to return to that item’s bulk results page. Its internal search identifier does not create an independently pollable Search resource. Search confidence, candidate-discovery behavior, and profile depth have the same meanings as in an individual search.`}),`\n`,_jsx(_components.p,{children:`Results become available in small groups after their billing completes. A slow item can delay publication of the other items in its group.`}),`\n`,_jsx(Heading,{level:`2`,id:`billing-and-cancellation`,children:`Billing and Cancellation`}),`\n`,_jsx(_components.p,{children:`Credits are reserved as groups of items begin processing. Orbit charges for the results under the pricing rules and releases unused credits. Retrying a job or reading its saved results does not repeat its search charges. Different item ids represent separate searches, even if their inputs are identical.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` /v3/search/bulk/{job_id}/cancel`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Cancellation skips undispatched items. Work that already started finishes reconciling and billing, so cancellation can remain pending while that work completes. Published results stay available.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Bulk Search","sidebarTitle":"Bulk Search","description":"Submit many searches as one resumable job.","openapi":"openapi.json POST /v3/search/bulk","href":"/api/search/bulk-search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Submit and Retry","slug":"submit-and-retry","depth":2,"children":[]},{"title":"Track Progress","slug":"track-progress","depth":2,"children":[]},{"title":"Read Results","slug":"read-results","depth":2,"children":[]},{"title":"Billing and Cancellation","slug":"billing-and-cancellation","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/orbit-5c173338/dc4679301029635e/toc-months.js"],"openApiReferenceData":{"operation":{"tags":["Search"],"summary":"Submit a Bulk Search Job","operationId":"submitBulkSearch","responses":{"202":"f7ab633d-ca2d-4a8f-a848-6e9c2f47d160","400":"f5c2f273-32f6-41a4-96fa-d8feb7224008","401":"5750ed8f-1d0b-4fea-bc66-0e4752e51e1f","403":"5e8342a3-330f-407c-8cbb-8ed2f68f61c4","409":"46dd1163-0314-40e3-96cb-8858a1c98bca","429":"3da000cc-e79b-47f0-91c4-8bb015464c28"},"description":"Submit many searches as one resumable job.","requestBody":"ff83a787-d574-4245-a5aa-fde0c2b0e72d","method":"post","type":"path","servers":["1b4a0f77-4036-4a1c-8df8-e593ae1ad48d"],"security":["9cbd971c-25cc-46c5-8e19-38bb281e438c"],"path":"/v3/search/bulk","baseUrlOptions":["https://api.orbitsearch.com"],"title":"Submit a Bulk Search Job","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["request_id","items"],"properties":{"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"items":{"type":"array","minItems":1,"maxItems":5000,"items":{"oneOf":[{"type":"object","description":"Provide `query`, `intent`, at least one identity signal, or a supported combination. When query and intent are both present, Orbit derives a base intent from query and overlays the caller-provided intent. Arrays, scalar values, and null replace derived values; nested objects merge field by field.","required":["id","query"],"example":{"query":"Machine learning engineers at Anthropic near San Francisco","intent":{"experiences":[{"titleAnyOf":["Research Engineer","ML Engineer"],"organization":"Anthropic","temporalScope":"current"}],"geo":{"distance":"25 miles"}},"candidate_discovery":true,"profile_depth":"partial","include_profile":true,"limit":10,"id":"search-ml-sf-001"},"properties":{"query":{"type":"string","minLength":1,"description":"A plain-English description of the people you want. When intent is also present, Orbit derives a base intent from this query before applying the caller-provided structured fields.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.query","typeLabel":"string"},"id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.id","typeLabel":"string"},"intent":{"type":"object","description":"Advanced structured criteria. Do not include a `version` field.","minProperties":1,"additionalProperties":false,"properties":{"names":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.names.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.names","typeLabel":"string[]"},"experiences":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].title","typeLabel":"string"},"titleAnyOf":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].titleAnyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].titleAnyOf","typeLabel":"string[]"},"organization":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].organization","typeLabel":"string"},"year":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].year","typeLabel":"integer"},"startYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].startYear","typeLabel":"integer"},"startYearLte":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].startYearLte","typeLabel":"integer"},"endYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].endYear","typeLabel":"integer"},"temporalScope":{"type":"string","enum":["current","historical","both"],"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX].temporalScope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.experiences","typeLabel":"object[]"},"semanticClauses":{"type":"array","items":{"oneOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.0.text","typeLabel":"string"},"anyOf":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.0.anyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.0.anyOf","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["anyOf"],"properties":{"anyOf":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.1.anyOf.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.1.anyOf","typeLabel":"string[]"},"text":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.1.text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.semanticClauses","typeLabel":"object[]"},"schools":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"school":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].school","typeLabel":"string"},"schoolAnyOf":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].schoolAnyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].schoolAnyOf","typeLabel":"string[]"},"graduationYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].graduationYear","typeLabel":"integer"},"startYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].startYear","typeLabel":"integer"},"endYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].endYear","typeLabel":"integer"},"temporalScope":{"type":"string","enum":["current","historical","both"],"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].temporalScope","typeLabel":"enum\u003cstring>"},"relation":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX].relation","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.schools","typeLabel":"object[]"},"geo":{"oneOf":[{"type":"object","properties":{"place":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.geo.oneOf.0.place","typeLabel":"string"},"isHistorical":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.geo.oneOf.0.isHistorical","typeLabel":"boolean"},"distance":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.geo.oneOf.0.distance","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.geo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.geo.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.geo","typeLabel":"object | null"},"demographics":{"oneOf":[{"type":"object","properties":{"ageRange":{"type":"object","additionalProperties":false,"required":["min","max"],"properties":{"min":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.ageRange.min","typeLabel":"integer"},"max":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.ageRange.max","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.ageRange","typeLabel":"object"},"birthYearRange":{"type":"object","additionalProperties":false,"required":["min","max"],"properties":{"min":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.birthYearRange.min","typeLabel":"integer"},"max":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.birthYearRange.max","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.birthYearRange","typeLabel":"object"},"gender":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0.gender","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.demographics","typeLabel":"object | null"},"personalization":{"oneOf":[{"type":"object","properties":{"network":{"type":"object","additionalProperties":false,"required":["scope"],"properties":{"scope":{"type":"string","enum":["first_degree"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization.oneOf.0.network.scope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization.oneOf.0.network","typeLabel":"object"},"nearMe":{"type":"object","additionalProperties":false,"required":["distance"],"properties":{"distance":{"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization.oneOf.0.nearMe.distance","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization.oneOf.0.nearMe","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent.personalization","typeLabel":"object | null"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0.intent","typeLabel":"object"},"signals":{"type":"object","description":"Identity signals for bulk Search. Face search uses the individual Search endpoint.","minProperties":1,"properties":{"address":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.address","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.phone","typeLabel":"string"},"linkedin_url":{"type":"string","format":"uri","uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.linkedin_url","typeLabel":"string\u003curi>"},"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.urls","typeLabel":"string\u003curi>[]"},"usernames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.usernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.usernames","typeLabel":"string[]"},"face_source":{"type":"object","description":"A face from a photo. It is enough on its own: the search returns the possible people, up to `candidate_discovery_limit`, best match first.","required":["image_url"],"properties":{"image_url":{"type":"string","minLength":1,"description":"The photo reference returned by `POST /v3/faces/detect`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.face_source.image_url","typeLabel":"string"},"bbox":{"type":"array","items":{"type":"number","minimum":0,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.face_source.bbox.items.[INDEX]","typeLabel":"number"},"description":"The picked face's box from `POST /v3/faces/detect`. Required when the photo has more than one face.","maxItems":4,"minItems":4,"example":[212,140,388,356],"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.face_source.bbox","typeLabel":"number[]"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals.face_source","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0.signals","typeLabel":"object"},"candidate_discovery":{"type":"boolean","default":false,"description":"Continue beyond known matches to find additional people. Address, email, and phone signals can each resolve to multiple associated people.","uniqueKey":"\\items.items.[INDEX].oneOf.0.candidate_discovery","typeLabel":"boolean"},"candidate_discovery_limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"Maximum number of Candidate Discovery results. Valid only with candidate_discovery set to true. A lower value reduces downstream profile-generation fanout, although source discovery and clustering can still dominate initial discovery time.","uniqueKey":"\\items.items.[INDEX].oneOf.0.candidate_discovery_limit","typeLabel":"integer"},"profile_depth":{"type":"string","enum":["quick","partial","full"],"default":"partial","description":"The minimum profile depth required for each ready result.","uniqueKey":"\\items.items.[INDEX].oneOf.0.profile_depth","typeLabel":"enum\u003cstring>"},"include_profile":{"type":"boolean","default":true,"description":"Embed each readable result's profile with its identity fields, contact fields, and generated sections. Read GET /v3/enrich/{profile_id} for the image gallery and source links. This controls the response shape; profile_depth controls how deep each profile is built.","uniqueKey":"\\items.items.[INDEX].oneOf.0.include_profile","typeLabel":"boolean"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"The maximum number of matches returned from the existing Orbit index. Candidate Discovery results append outside this limit, and profile upgrades update selected results in place.","uniqueKey":"\\items.items.[INDEX].oneOf.0.limit","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Provide `query`, `intent`, at least one identity signal, or a supported combination. When query and intent are both present, Orbit derives a base intent from query and overlays the caller-provided intent. Arrays, scalar values, and null replace derived values; nested objects merge field by field.","required":["id","intent"],"example":{"query":"Machine learning engineers at Anthropic near San Francisco","intent":{"experiences":[{"titleAnyOf":["Research Engineer","ML Engineer"],"organization":"Anthropic","temporalScope":"current"}],"geo":{"distance":"25 miles"}},"candidate_discovery":true,"profile_depth":"partial","include_profile":true,"limit":10,"id":"search-ml-sf-001"},"properties":{"intent":{"type":"object","description":"Advanced structured criteria. Do not include a `version` field.","minProperties":1,"additionalProperties":false,"properties":{"names":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.names.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.names","typeLabel":"string[]"},"experiences":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].title","typeLabel":"string"},"titleAnyOf":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].titleAnyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].titleAnyOf","typeLabel":"string[]"},"organization":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].organization","typeLabel":"string"},"year":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].year","typeLabel":"integer"},"startYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].startYear","typeLabel":"integer"},"startYearLte":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].startYearLte","typeLabel":"integer"},"endYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].endYear","typeLabel":"integer"},"temporalScope":{"type":"string","enum":["current","historical","both"],"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX].temporalScope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.experiences","typeLabel":"object[]"},"semanticClauses":{"type":"array","items":{"oneOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.0.text","typeLabel":"string"},"anyOf":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.0.anyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.0.anyOf","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["anyOf"],"properties":{"anyOf":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.1.anyOf.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.1.anyOf","typeLabel":"string[]"},"text":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.1.text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.semanticClauses","typeLabel":"object[]"},"schools":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"school":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].school","typeLabel":"string"},"schoolAnyOf":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].schoolAnyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].schoolAnyOf","typeLabel":"string[]"},"graduationYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].graduationYear","typeLabel":"integer"},"startYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].startYear","typeLabel":"integer"},"endYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].endYear","typeLabel":"integer"},"temporalScope":{"type":"string","enum":["current","historical","both"],"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].temporalScope","typeLabel":"enum\u003cstring>"},"relation":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX].relation","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.schools","typeLabel":"object[]"},"geo":{"oneOf":[{"type":"object","properties":{"place":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.geo.oneOf.0.place","typeLabel":"string"},"isHistorical":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.geo.oneOf.0.isHistorical","typeLabel":"boolean"},"distance":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.geo.oneOf.0.distance","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.geo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.geo.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.geo","typeLabel":"object | null"},"demographics":{"oneOf":[{"type":"object","properties":{"ageRange":{"type":"object","additionalProperties":false,"required":["min","max"],"properties":{"min":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.ageRange.min","typeLabel":"integer"},"max":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.ageRange.max","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.ageRange","typeLabel":"object"},"birthYearRange":{"type":"object","additionalProperties":false,"required":["min","max"],"properties":{"min":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.birthYearRange.min","typeLabel":"integer"},"max":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.birthYearRange.max","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.birthYearRange","typeLabel":"object"},"gender":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0.gender","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.demographics","typeLabel":"object | null"},"personalization":{"oneOf":[{"type":"object","properties":{"network":{"type":"object","additionalProperties":false,"required":["scope"],"properties":{"scope":{"type":"string","enum":["first_degree"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization.oneOf.0.network.scope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization.oneOf.0.network","typeLabel":"object"},"nearMe":{"type":"object","additionalProperties":false,"required":["distance"],"properties":{"distance":{"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization.oneOf.0.nearMe.distance","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization.oneOf.0.nearMe","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent.personalization","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.intent","typeLabel":"object"},"id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.id","typeLabel":"string"},"query":{"type":"string","minLength":1,"description":"A plain-English description of the people you want. When intent is also present, Orbit derives a base intent from this query before applying the caller-provided structured fields.","uniqueKey":"\\items.items.[INDEX].oneOf.1.query","typeLabel":"string"},"signals":{"type":"object","description":"Identity signals for bulk Search. Face search uses the individual Search endpoint.","minProperties":1,"properties":{"address":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.address","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.phone","typeLabel":"string"},"linkedin_url":{"type":"string","format":"uri","uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.linkedin_url","typeLabel":"string\u003curi>"},"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.urls","typeLabel":"string\u003curi>[]"},"usernames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.usernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.usernames","typeLabel":"string[]"},"face_source":{"type":"object","description":"A face from a photo. It is enough on its own: the search returns the possible people, up to `candidate_discovery_limit`, best match first.","required":["image_url"],"properties":{"image_url":{"type":"string","minLength":1,"description":"The photo reference returned by `POST /v3/faces/detect`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.face_source.image_url","typeLabel":"string"},"bbox":{"type":"array","items":{"type":"number","minimum":0,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.face_source.bbox.items.[INDEX]","typeLabel":"number"},"description":"The picked face's box from `POST /v3/faces/detect`. Required when the photo has more than one face.","maxItems":4,"minItems":4,"example":[212,140,388,356],"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.face_source.bbox","typeLabel":"number[]"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals.face_source","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1.signals","typeLabel":"object"},"candidate_discovery":{"type":"boolean","default":false,"description":"Continue beyond known matches to find additional people. Address, email, and phone signals can each resolve to multiple associated people.","uniqueKey":"\\items.items.[INDEX].oneOf.1.candidate_discovery","typeLabel":"boolean"},"candidate_discovery_limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"Maximum number of Candidate Discovery results. Valid only with candidate_discovery set to true. A lower value reduces downstream profile-generation fanout, although source discovery and clustering can still dominate initial discovery time.","uniqueKey":"\\items.items.[INDEX].oneOf.1.candidate_discovery_limit","typeLabel":"integer"},"profile_depth":{"type":"string","enum":["quick","partial","full"],"default":"partial","description":"The minimum profile depth required for each ready result.","uniqueKey":"\\items.items.[INDEX].oneOf.1.profile_depth","typeLabel":"enum\u003cstring>"},"include_profile":{"type":"boolean","default":true,"description":"Embed each readable result's profile with its identity fields, contact fields, and generated sections. Read GET /v3/enrich/{profile_id} for the image gallery and source links. This controls the response shape; profile_depth controls how deep each profile is built.","uniqueKey":"\\items.items.[INDEX].oneOf.1.include_profile","typeLabel":"boolean"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"The maximum number of matches returned from the existing Orbit index. Candidate Discovery results append outside this limit, and profile upgrades update selected results in place.","uniqueKey":"\\items.items.[INDEX].oneOf.1.limit","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"Provide `query`, `intent`, at least one identity signal, or a supported combination. When query and intent are both present, Orbit derives a base intent from query and overlays the caller-provided intent. Arrays, scalar values, and null replace derived values; nested objects merge field by field.","required":["id","signals"],"example":{"query":"Machine learning engineers at Anthropic near San Francisco","intent":{"experiences":[{"titleAnyOf":["Research Engineer","ML Engineer"],"organization":"Anthropic","temporalScope":"current"}],"geo":{"distance":"25 miles"}},"candidate_discovery":true,"profile_depth":"partial","include_profile":true,"limit":10,"id":"search-ml-sf-001"},"properties":{"signals":{"type":"object","description":"Identity signals for bulk Search. Face search uses the individual Search endpoint.","minProperties":1,"properties":{"address":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.address","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.phone","typeLabel":"string"},"linkedin_url":{"type":"string","format":"uri","uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.linkedin_url","typeLabel":"string\u003curi>"},"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.urls","typeLabel":"string\u003curi>[]"},"usernames":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.usernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.usernames","typeLabel":"string[]"},"face_source":{"type":"object","description":"A face from a photo. It is enough on its own: the search returns the possible people, up to `candidate_discovery_limit`, best match first.","required":["image_url"],"properties":{"image_url":{"type":"string","minLength":1,"description":"The photo reference returned by `POST /v3/faces/detect`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.face_source.image_url","typeLabel":"string"},"bbox":{"type":"array","items":{"type":"number","minimum":0,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.face_source.bbox.items.[INDEX]","typeLabel":"number"},"description":"The picked face's box from `POST /v3/faces/detect`. Required when the photo has more than one face.","maxItems":4,"minItems":4,"example":[212,140,388,356],"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.face_source.bbox","typeLabel":"number[]"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals.face_source","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.signals","typeLabel":"object"},"id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.id","typeLabel":"string"},"query":{"type":"string","minLength":1,"description":"A plain-English description of the people you want. When intent is also present, Orbit derives a base intent from this query before applying the caller-provided structured fields.","uniqueKey":"\\items.items.[INDEX].oneOf.2.query","typeLabel":"string"},"intent":{"type":"object","description":"Advanced structured criteria. Do not include a `version` field.","minProperties":1,"additionalProperties":false,"properties":{"names":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.names.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.names","typeLabel":"string[]"},"experiences":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].title","typeLabel":"string"},"titleAnyOf":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].titleAnyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].titleAnyOf","typeLabel":"string[]"},"organization":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].organization","typeLabel":"string"},"year":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].year","typeLabel":"integer"},"startYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].startYear","typeLabel":"integer"},"startYearLte":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].startYearLte","typeLabel":"integer"},"endYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].endYear","typeLabel":"integer"},"temporalScope":{"type":"string","enum":["current","historical","both"],"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX].temporalScope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.experiences","typeLabel":"object[]"},"semanticClauses":{"type":"array","items":{"oneOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.0.text","typeLabel":"string"},"anyOf":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.0.anyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.0.anyOf","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["anyOf"],"properties":{"anyOf":{"type":"array","minItems":1,"items":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.1.anyOf.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.1.anyOf","typeLabel":"string[]"},"text":{"type":"string","minLength":1,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.1.text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.semanticClauses","typeLabel":"object[]"},"schools":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"school":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].school","typeLabel":"string"},"schoolAnyOf":{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].schoolAnyOf.items.[INDEX]","typeLabel":"string"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].schoolAnyOf","typeLabel":"string[]"},"graduationYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].graduationYear","typeLabel":"integer"},"startYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].startYear","typeLabel":"integer"},"endYear":{"type":"integer","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].endYear","typeLabel":"integer"},"temporalScope":{"type":"string","enum":["current","historical","both"],"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].temporalScope","typeLabel":"enum\u003cstring>"},"relation":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX].relation","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.schools","typeLabel":"object[]"},"geo":{"oneOf":[{"type":"object","properties":{"place":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.geo.oneOf.0.place","typeLabel":"string"},"isHistorical":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.geo.oneOf.0.isHistorical","typeLabel":"boolean"},"distance":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.geo.oneOf.0.distance","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.geo.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.geo.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.geo","typeLabel":"object | null"},"demographics":{"oneOf":[{"type":"object","properties":{"ageRange":{"type":"object","additionalProperties":false,"required":["min","max"],"properties":{"min":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.ageRange.min","typeLabel":"integer"},"max":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.ageRange.max","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.ageRange","typeLabel":"object"},"birthYearRange":{"type":"object","additionalProperties":false,"required":["min","max"],"properties":{"min":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.birthYearRange.min","typeLabel":"integer"},"max":{"type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.birthYearRange.max","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.birthYearRange","typeLabel":"object"},"gender":{"type":"string","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0.gender","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.demographics","typeLabel":"object | null"},"personalization":{"oneOf":[{"type":"object","properties":{"network":{"type":"object","additionalProperties":false,"required":["scope"],"properties":{"scope":{"type":"string","enum":["first_degree"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization.oneOf.0.network.scope","typeLabel":"enum\u003cstring>"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization.oneOf.0.network","typeLabel":"object"},"nearMe":{"type":"object","additionalProperties":false,"required":["distance"],"properties":{"distance":{"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization.oneOf.0.nearMe.distance","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization.oneOf.0.nearMe","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent.personalization","typeLabel":"object | null"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2.intent","typeLabel":"object"},"candidate_discovery":{"type":"boolean","default":false,"description":"Continue beyond known matches to find additional people. Address, email, and phone signals can each resolve to multiple associated people.","uniqueKey":"\\items.items.[INDEX].oneOf.2.candidate_discovery","typeLabel":"boolean"},"candidate_discovery_limit":{"type":"integer","minimum":1,"maximum":50,"default":10,"description":"Maximum number of Candidate Discovery results. Valid only with candidate_discovery set to true. A lower value reduces downstream profile-generation fanout, although source discovery and clustering can still dominate initial discovery time.","uniqueKey":"\\items.items.[INDEX].oneOf.2.candidate_discovery_limit","typeLabel":"integer"},"profile_depth":{"type":"string","enum":["quick","partial","full"],"default":"partial","description":"The minimum profile depth required for each ready result.","uniqueKey":"\\items.items.[INDEX].oneOf.2.profile_depth","typeLabel":"enum\u003cstring>"},"include_profile":{"type":"boolean","default":true,"description":"Embed each readable result's profile with its identity fields, contact fields, and generated sections. Read GET /v3/enrich/{profile_id} for the image gallery and source links. This controls the response shape; profile_depth controls how deep each profile is built.","uniqueKey":"\\items.items.[INDEX].oneOf.2.include_profile","typeLabel":"boolean"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"The maximum number of matches returned from the existing Orbit index. Candidate Discovery results append outside this limit, and profile upgrades update selected results in place.","uniqueKey":"\\items.items.[INDEX].oneOf.2.limit","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"\\items.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"request_id":"\u003cstring>","items":[{"query":"Machine learning engineers at Anthropic near San Francisco","intent":{"experiences":[{"titleAnyOf":["Research Engineer","ML Engineer"],"organization":"Anthropic","temporalScope":"current"}],"geo":{"distance":"25 miles"}},"candidate_discovery":true,"profile_depth":"partial","include_profile":true,"limit":10,"id":"search-ml-sf-001"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f7ab633d-ca2d-4a8f-a848-6e9c2f47d160":{"description":"Bulk search response.","content":{"application/json":{"schema":{"type":"object","required":["job_id","request_id","status","cancel_requested","counts","billing","last_error","created_at","updated_at","links"],"properties":{"job_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"job_id","typeLabel":"string\u003cuuid>"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"status":{"type":"string","enum":["queued","running","waiting_for_credits","needs_attention","completed","completed_with_errors","canceled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"cancel_requested":{"type":"boolean","isRequired":true,"uniqueKey":"cancel_requested","typeLabel":"boolean"},"counts":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"counts.total","typeLabel":"integer"},"completed":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"counts.completed","typeLabel":"integer"},"failed":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"counts.failed","typeLabel":"integer"},"canceled":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"counts.canceled","typeLabel":"integer"},"pending":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"counts.pending","typeLabel":"integer"}},"required":["total","completed","failed","canceled","pending"],"isRequired":true,"uniqueKey":"counts","typeLabel":"object"},"billing":{"type":"object","properties":{"consumed_credits":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"billing.consumed_credits","typeLabel":"integer"},"held_credits":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"billing.held_credits","typeLabel":"integer"}},"required":["consumed_credits","held_credits"],"isRequired":true,"uniqueKey":"billing","typeLabel":"object"},"last_error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"last_error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"last_error.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"last_error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"last_error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_error","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"links.status","typeLabel":"string"},"results":{"type":"string","isRequired":true,"uniqueKey":"links.results","typeLabel":"string"},"cancel":{"type":"string","isRequired":true,"uniqueKey":"links.cancel","typeLabel":"string"}},"required":["status","results","cancel"],"isRequired":true,"uniqueKey":"links","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"job_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","request_id":"\u003cstring>","status":"queued","cancel_requested":true,"counts":{"total":1,"completed":1,"failed":1,"canceled":1,"pending":1},"billing":{"consumed_credits":1,"held_credits":1},"last_error":{"code":"\u003cstring>","message":"\u003cstring>"},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","links":{"status":"\u003cstring>","results":"\u003cstring>","cancel":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f5c2f273-32f6-41a4-96fa-d8feb7224008":{"description":"The request is not valid.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"5750ed8f-1d0b-4fea-bc66-0e4752e51e1f":{"description":"The API key is missing or not valid.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"5e8342a3-330f-407c-8cbb-8ed2f68f61c4":{"description":"The API key does not have the required scope.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"46dd1163-0314-40e3-96cb-8858a1c98bca":{"description":"The request ID was already used with different inputs.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"3da000cc-e79b-47f0-91c4-8bb015464c28":{"description":"Bulk HTTP request rate exceeded. Honor Retry-After; accepted jobs continue processing.","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds before retrying this HTTP request."}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9cbd971c-25cc-46c5-8e19-38bb281e438c":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Orbit API key","description":"Use an Orbit API key from the Developer Dashboard.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1b4a0f77-4036-4a1c-8df8-e593ae1ad48d":{"url":"https://api.orbitsearch.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Orbit API key","description":"Use an Orbit API key from the Developer Dashboard.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use an Orbit API key from the Developer Dashboard.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"orbit-5c173338","siteName":"Orbit Developer API","title":"Bulk Search - Orbit Developer API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T19:42:22.104Z","originalFileLocation":"api/search/bulk-search.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Submit many searches as one resumable job.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orbit Developer API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bulk Search - Orbit Developer API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit many searches as one resumable job.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orbit Developer API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbitsearch.com/api/search/bulk-search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orbit-5c173338.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Bulk+Search\u0026amp;description=Submit+many+searches+as+one+resumable+job.\u0026amp;theme=80a38a31624f90b17e1fb697\u0026amp;signature=9e4e7c7596797af6dcbd7f9502eddae5137fcd962e0c74bf357cc9a8858478fa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Bulk Search - Orbit Developer API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit many searches as one resumable job.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orbit-5c173338.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Bulk+Search\u0026amp;description=Submit+many+searches+as+one+resumable+job.\u0026amp;theme=80a38a31624f90b17e1fb697\u0026amp;signature=9e4e7c7596797af6dcbd7f9502eddae5137fcd962e0c74bf357cc9a8858478fa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orbit Developer API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0875B9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orbitsearch.com/api/search/bulk-search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/search/bulk-search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orbitsearch.com/#organization\",\"name\":\"Orbit Developer API\",\"url\":\"https://docs.orbitsearch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orbit-5c173338/k-iXLNt-i1YvMS-Z/assets/orbit-logo-mark.png?fit=max\u0026auto=format\u0026n=k-iXLNt-i1YvMS-Z\u0026q=85\u0026s=8b0d9a458f0dbb073a9c9e109b9057bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orbitsearch.com#website\",\"name\":\"Orbit Developer API\",\"url\":\"https://docs.orbitsearch.com\",\"publisher\":{\"@id\":\"https://docs.orbitsearch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orbitsearch.com/api/search/bulk-search#webpage\",\"url\":\"https://docs.orbitsearch.com/api/search/bulk-search\",\"name\":\"Bulk Search\",\"description\":\"Submit many searches as one resumable job.\",\"dateModified\":\"2026-09-29T19:42:22.104Z\",\"isPartOf\":{\"@id\":\"https://docs.orbitsearch.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orbitsearch.com/api/search/bulk-search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orbitsearch.com/api/search/bulk-search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search\",\"item\":\"https://docs.orbitsearch.com/api/search/search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Bulk Search\",\"item\":\"https://docs.orbitsearch.com/api/search/bulk-search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orbitsearch.com/api/search/bulk-search#apireference\",\"headline\":\"Bulk Search\",\"name\":\"Bulk Search\",\"description\":\"Submit many searches as one resumable job.\",\"url\":\"https://docs.orbitsearch.com/api/search/bulk-search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbitsearch.com/api/search/bulk-search#webpage\"},\"dateModified\":\"2026-09-29T19:42:22.104Z\",\"publisher\":{\"@id\":\"https://docs.orbitsearch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orbitsearch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orbit Developer API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Orbit Developer API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/search/bulk-search.md","siteName":"Orbit Developer API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Reference","groups":[{"group":"Search","pages":[{"title":"Start a People Search","sidebarTitle":"Start a Search","openapi":"openapi.json POST /v3/search","href":"/api/search/search"},{"title":"Get Search Status","sidebarTitle":"Get Search Status","description":"Poll a people search, track each phase, and use results as they become ready.","openapi":"openapi.json GET /v3/search/{search_id}","href":"/api/search/search-status"},{"title":"Bulk Search","sidebarTitle":"Bulk Search","openapi":"openapi.json POST /v3/search/bulk","href":"/api/search/bulk-search"},{"title":"Structured Search Intent","sidebarTitle":"Structured Intent","description":"Describe names, work experience, skills, schools, location, demographics, and personalization for Search.","href":"/api/search/search-intent"},{"title":"Price a Population Search","sidebarTitle":"Price a Population","openapi":"openapi.json POST /v3/search/populations/quote","href":"/api/search/population-quote"},{"title":"Search a Population","sidebarTitle":"Search a Population","openapi":"openapi.json POST /v3/search/populations","href":"/api/search/population"},{"title":"Detect Faces","sidebarTitle":"Detect Faces","openapi":"openapi.json POST /v3/faces/detect","href":"/api/search/faces-detect"},{"title":"Search the Face Index","sidebarTitle":"Search Face Index","openapi":"openapi.json POST /v3/faces/index-search","href":"/api/search/faces-index-search"}]},{"group":"Enrich","pages":[{"title":"Read a Profile","sidebarTitle":"Read a Profile","openapi":"openapi.json GET /v3/enrich/{profile_id}","href":"/api/enrich/read-profile"},{"title":"Enrich a Profile","sidebarTitle":"Enrich a Profile","openapi":"openapi.json POST /v3/enrich/{profile_id}","href":"/api/enrich/enrich-profile"},{"title":"Get Enrichment Status","sidebarTitle":"Get Enrich Status","openapi":"openapi.json GET /v3/enrich/requests/{request_id}","href":"/api/enrich/enrich-status"},{"title":"Batch Enrich Profiles","sidebarTitle":"Batch Enrich","openapi":"openapi.json POST /v3/enrich","href":"/api/enrich/batch-enrich"}]},{"group":"People","pages":[{"title":"Network Graph","sidebarTitle":"Network Graph","openapi":"openapi.json GET /v3/people/{profile_id}/network/path","href":"/api/people/network-graph"}]},{"group":"Watchers","pages":[{"title":"Create a Watcher","sidebarTitle":"Create a Watcher","openapi":"openapi.json POST /v3/watchers","href":"/api/watchers/create"},{"title":"List Watchers","sidebarTitle":"List Watchers","openapi":"openapi.json GET /v3/watchers","href":"/api/watchers/list"},{"title":"Get a Watcher","sidebarTitle":"Get a Watcher","openapi":"openapi.json GET /v3/watchers/{watcher_id}","href":"/api/watchers/get"},{"title":"Update a Watcher","sidebarTitle":"Update a Watcher","openapi":"openapi.json PATCH /v3/watchers/{watcher_id}","href":"/api/watchers/update"},{"title":"Delete a Watcher","sidebarTitle":"Delete a Watcher","openapi":"openapi.json DELETE /v3/watchers/{watcher_id}","href":"/api/watchers/delete"},{"title":"List Watcher Runs","sidebarTitle":"Watcher Runs","openapi":"openapi.json GET /v3/watchers/{watcher_id}/runs","href":"/api/watchers/runs"}]},{"group":"Webhooks","pages":[{"title":"Create a Webhook Endpoint","sidebarTitle":"Create an Endpoint","openapi":"openapi.json POST /v3/webhooks","href":"/api/webhooks/create"},{"title":"List Webhook Endpoints","sidebarTitle":"List Endpoints","openapi":"openapi.json GET /v3/webhooks","href":"/api/webhooks/list"},{"title":"Send a Test Webhook Delivery","sidebarTitle":"Send a Test Delivery","openapi":"openapi.json POST /v3/webhooks/{webhook_id}/test","href":"/api/webhooks/test"},{"title":"Delete a Webhook Endpoint","sidebarTitle":"Delete an Endpoint","openapi":"openapi.json DELETE /v3/webhooks/{webhook_id}","href":"/api/webhooks/delete"},{"title":"Webhook Events and Signature Verification","sidebarTitle":"Events \u0026 Signatures","href":"/api/webhooks/events"}]},{"group":"Agents","pages":[{"title":"Sign Up as an Agent","sidebarTitle":"Agent Signup","openapi":"openapi.json POST /v3/agents/signup","href":"/api/agents/signup"}]},{"group":"Keys","pages":[{"title":"Get Your Orbit Search API Key","sidebarTitle":"Get API Key","href":"/api/api-keys/create"},{"title":"View and Audit Your Orbit Search API Keys","sidebarTitle":"View Keys","href":"/api/api-keys/list"},{"title":"Revoke or Delete an Orbit Search API Key","sidebarTitle":"Revoke Keys","href":"/api/api-keys/revoke"},{"title":"View API Usage","sidebarTitle":"Usage","href":"/api/api-keys/usage"}]}]}]},"basePath":"","title":"Bulk Search - Orbit Developer API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DRLI_2Ue.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}