Sources

Create Source

Create a new source. Behavior is source-specific: typically the source imports matching records immediately (when pull_existing or equivalent is set) and — for an ongoing source — keeps re-importing on a schedule.

Per-source body shapes and field semantics live in /docs/source-detail/{source_id}.txt. The route schema only enforces that the body is a JSON object; per-source validation runs inside the handler and surfaces as 400 with a specific message and, when multiple fields fail, an errors[] array of {field, message} entries.

Returns source_instance_id (the new source's UUID). The initial import runs asynchronously: the call returns as soon as the source is created and the import is queued, not when records have finished arriving.

post/api/v1/sources/{source_id}

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

source_idstring required

Source identifier. Currently supported: find_companies, find_companies_by_tech_stack, find_companies_from_sales_navigator, find_companies_hiring, find_ecommerce_stores, find_job_postings, find_linkedin_post_reactors, find_linkedin_posts, find_people, find_people_from_sales_navigator, import_from_ai_ark, import_from_attio, import_from_fireflies, import_from_gmail, import_from_google_sheets, import_from_hubspot, import_from_pipedrive, import_from_salesforce, import_from_slack, import_from_snowflake, import_from_stripe, import_from_typeform, import_from_zoho, search_local_businesses, search_x_tweets, track_companies_hiring, track_job_postings, track_linkedin_posts, track_personal_website_visitors, track_website_visitors, track_x_posts.

Request body

SourceCreateBody required

Per-source create body. Shape depends on source_id — see the provider README under modules/sources/ (and optionally /docs/source-detail/{source_id}.txt). Validated at the handler level; the schema only enforces that the body is a JSON object.

Response

Default Response

statusinteger

Changes

No recorded changes to this operation across all 1 revision of this API.