OrbiCrawl AI

Reference

API reference

Everything the dashboard does, over REST. Generated live from the OpenAPI spec — create crawl jobs, list and enrich leads, run AI search, manage schedules, workflows and integrations, and export data.

Interactive playground →OpenAPI JSON

Authentication

Send an API key as the X-API-Key header, or a short-lived access token as Authorization: Bearer <token> — details in Authentication.

bash
curl https://api.orbicrawl.com/api/v1/jobs \
  -H "X-API-Key: oc_live_..." \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://acme.com"],"config":{"max_depth":1}}'

Endpoints (71)

AIAnalyticsBillingComplianceDigestsDiscoveryHealthHiringICPIntegrationsJobsLeadsSaved searchesSchedulesTagsToolsWorkflowsWorkspace

AI8

post/ai/assistantIn-dashboard AI assistant grounded in the workspace's data

Accepts a JSON request body — see the interactive playground for the full schema.

post/ai/jobs/{id}/icp-match-allScore a job's unscored leads against the workspace ICP

Parameters

  • idpathrequired
post/ai/leads/{id}/emailGenerate a personalized outreach email for a lead — charges credits

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

post/ai/leads/{id}/enrichAI-enrich a lead (summary, category, industry, lead score) — charges credits

Parameters

  • idpathrequired
post/ai/leads/{id}/icp-matchScore a lead against the workspace's Ideal Customer Profile — charges credits

Parameters

  • idpathrequired
get/ai/leads/{id}/outreachStored outreach generations for a lead

Parameters

  • idpathrequired
post/ai/leads/{id}/outreachGenerate and store an outreach asset

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

post/ai/searchNatural-language lead search — AI translates the query into a filter and returns matching leads

Accepts a JSON request body — see the interactive playground for the full schema.

Analytics2

get/analytics/forecastUsage & credit forecast — avg daily burn, days-until-empty, 30-day projection
get/analytics/overviewWorkspace analytics — activity charts, top segments, quality/deliverability breakdowns

Billing3

get/billing/currenciesSupported display currencies + FX rates
get/billing/overviewSubscription, wallet and recent ledger
get/billing/plansPublic plan catalog (optional ?currency= converts prices)

Parameters

  • currencyquery

Compliance5

get/compliance/deletion-requestsList deletion requests
post/compliance/deletion-requestsFile a data-deletion request
get/compliance/exportExport all workspace data as JSON (GDPR portability)
delete/compliance/leadsErase all leads (right to erasure)
put/compliance/retentionSet the lead data-retention window (days)

Digests2

get/digestsList digest subscriptions
post/digestsSchedule a recurring digest by email and/or Slack

Accepts a JSON request body — see the interactive playground for the full schema.

Discovery2

post/discoverySearch-engine discovery — find candidate company websites for a query

Accepts a JSON request body — see the interactive playground for the full schema.

post/discovery/mapsGoogle Maps / Places discovery (needs GOOGLE_PLACES_API_KEY)

Accepts a JSON request body — see the interactive playground for the full schema.

Health1

get/healthLiveness + dependency check

Hiring3

get/hiring/companiesCompanies hiring, aggregated into a lead list

Parameters

  • techquery
  • titlequery
  • countryquery
  • posted_within_daysquery
  • min_rolesqueryOnly companies with at least this many matching roles
  • limitquery
get/hiring/searchOpen roles matching a hiring signal

Parameters

  • techqueryTechnology named in the posting; aliases resolve (reactjs -> React)
  • titlequerySubstring of the job title
  • countryquery
  • remotequery
  • posted_within_daysquery
  • limitquery
get/hiring/technologiesWhat the market is hiring for, most in demand first

ICP2

get/icpGet the workspace's Ideal Customer Profile
put/icpCreate or update the workspace's Ideal Customer Profile

Accepts a JSON request body — see the interactive playground for the full schema.

Integrations5

get/integrationsList outbound integrations (CRM / Zapier / Make / n8n)
post/integrationsConnect an integration (webhook | hubspot | pipedrive | zoho | airtable | google_sheets | slack)

Accepts a JSON request body — see the interactive playground for the full schema.

delete/integrations/{id}Remove an integration

Parameters

  • idpathrequired
post/integrations/{id}/pushPush leads to the integration (by job_id or lead_ids)

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

get/integrations/pushesRecent integration push attempts, including retries

Jobs8

get/jobsList crawl jobs

Parameters

  • pagequery
  • per_pagequery
  • statusquery
post/jobsCreate a crawl job from one or more URLs

Accepts a JSON request body — see the interactive playground for the full schema.

get/jobs/{id}Get a job

Parameters

  • idpathrequired
post/jobs/{id}/cancelCancel a running job (refunds unspent credits)

Parameters

  • idpathrequired
get/jobs/{id}/eventsServer-Sent Events stream of live progress

Parameters

  • idpathrequired
post/jobs/{id}/exportExport a job's leads (csv | xlsx | json)

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

get/jobs/{id}/leadsList leads for a job

Parameters

  • idpathrequired
post/jobs/csvCreate a crawl job from a CSV upload (multipart/form-data)

Accepts a JSON request body — see the interactive playground for the full schema.

Leads10

get/leadsList all leads in the workspace
get/leads/{id}/emailsPer-address email verification state for a lead

Parameters

  • idpathrequired
get/leads/{id}/emails/{email_id}/historyVerification history for one address

Parameters

  • idpathrequired
  • email_idpathrequired
post/leads/{id}/emails/verifyRe-verify every address on a lead now

Parameters

  • idpathrequired
get/leads/{id}/notesNotes on a lead

Parameters

  • idpathrequired
post/leads/{id}/notesAdd a note to a lead

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

get/leads/{id}/tagsTags on a lead

Parameters

  • idpathrequired
post/leads/{id}/tagsAssign a tag to a lead (by id, or create by name)

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

post/leads/captureSave a page as a lead (browser extension)

Accepts a JSON request body — see the interactive playground for the full schema.

get/leads/duplicatesDuplicate leads grouped by registrable domain

Saved searches2

get/saved-searchesList saved lead searches
post/saved-searchesSave a lead search

Accepts a JSON request body — see the interactive playground for the full schema.

Schedules7

get/schedulesList crawl schedules & monitors
post/schedulesCreate a recurring crawl or change monitor

Accepts a JSON request body — see the interactive playground for the full schema.

delete/schedules/{id}Delete a schedule

Parameters

  • idpathrequired
get/schedules/{id}Get a schedule

Parameters

  • idpathrequired
patch/schedules/{id}Update a schedule (enable/pause, interval, urls)

Parameters

  • idpathrequired
post/schedules/{id}/runRun a schedule immediately

Parameters

  • idpathrequired
get/schedules/changesRecent content-change events (website monitoring)

Tags2

get/tagsList workspace lead tags with usage counts
post/tagsCreate a tag

Accepts a JSON request body — see the interactive playground for the full schema.

Tools3

post/tools/extract-contactsExtract emails, phones and socials from a page (public, no auth)

Accepts a JSON request body — see the interactive playground for the full schema.

post/tools/techDetect the technologies behind a website (public, no auth)

Accepts a JSON request body — see the interactive playground for the full schema.

post/tools/verify-emailVerify an email address (public, no auth)

Accepts a JSON request body — see the interactive playground for the full schema.

Workflows4

get/workflowsList automation workflows
post/workflowsCreate a workflow (steps run against a job's leads)

Accepts a JSON request body — see the interactive playground for the full schema.

delete/workflows/{id}Delete a workflow

Parameters

  • idpathrequired
post/workflows/{id}/runRun a workflow against a job's leads

Parameters

  • idpathrequired

Accepts a JSON request body — see the interactive playground for the full schema.

Workspace2

get/workspace/brandingGet white-label branding
put/workspace/brandingUpdate white-label branding (admin)

← Previous

Integrations

Next →

SDKs