Core

Extractions

POST/v1/extractions

An extraction is the one resource that does everything. The request is three orthogonal choices — what, scope, and how much — plus optional output shaping, a session, and delivery.

Request fields

connectorstringrequired

Which site to extract from — e.g. linkedin, instagram, google_maps, or generic for any URL.

operationstringrequired

What to pull, from the connector's catalog — e.g. company.posts, search.posts, place.reviews.

inputobjectrequired

Operation-specific scope — the entity or search terms (a company, a profile, keywords, a URL).

collectobjectoptional

How much to gather. See collect modes. Defaults to { "mode": "limit", "limit": 100 }.

outputobjectoptional

Shape the result — pick fields, set a schema, choose json / ndjson / csv.

sessionstringoptional

A session id to run under — managed by us, or your own logged-in session.

deliveryobjectoptional

Where results go — sync, webhook, store, or a destination. See delivery.

One connector, two very different needs

Because operation and collect are independent, one connector serves opposite use cases without special endpoints.

Customer A — N posts on a topic

JSON

{
  "connector": "linkedin",
  "operation": "search.posts",
  "input": { "keywords": "cold brew" },
  "collect": { "mode": "limit", "limit": 200 }
}

Customer B — every post from a page

JSON

{
  "connector": "linkedin",
  "operation": "company.posts",
  "input": { "company": "microsoft" },
  "collect": { "mode": "all" }
}

Same envelope. operation picks search-vs-listing; collect decides the depth. Which internal search or pagination path satisfies it is our concern, not yours.