v2
v2-ingest

Ingest

Create an ingest job and enqueue it (202 + job_id).

Gate order matters: nothing is persisted until the quota gate passes — a 402 leaves zero rows behind. SSRF screening runs in the worker (the seed via discover_flow, each page via render_html), so submit stays instant.

post/v2/ingest

Request

  • Base URL: https://api.enconvert.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.enconvert.com/v2/ingest
  • Auth: none declared

Headers

X-API-Keystring nullable
authorizationstring nullable

Request body

mode'urls' | 'sitemap' | 'crawl' | 'files'
urlstring nullable

Seed URL for sitemap/crawl mode (the site to ingest).

urlsstring[] nullable

Explicit URLs to ingest (urls mode). Mutually exclusive with url.

max_pagesinteger

Cap on URLs discovered AND ingested in sitemap/crawl mode.

max_depthinteger
same_domain_onlyboolean
include_patternsstring[]
exclude_patternsstring[]
respect_robotsboolean
wait_forstring nullable
wait_timeout_msinteger
only_main_contentboolean

When true (default), each page's markdown strips site chrome (navigation, header, footer, sidebars, cookie banners, hidden nodes) behind a fidelity guard that falls back to the full page when stripping would remove too much real content. When false, the full page is chunked as-is.

truncate_data_arraysboolean nullable

Collapse long runs of numeric literals (raw embedding vectors, tensor dumps in notebook output cells) to a leading sample plus a count. Unset (the default) follows only_main_content.

webhook_urlstring nullable

Response

Successful Response

job_idstring required
status'queued' | 'discovering' | 'processing' | 'completed' | 'failed' | 'canceled' required
mode'urls' | 'sitemap' | 'crawl' | 'files' required
pages_discoveredinteger
pages_foundinteger nullable

Unique eligible URLs discovery yielded BEFORE the max_pages cap (sitemap: true unique count; crawl: bounded by the crawl budget, so a lower bound). Absent for explicit-urls jobs and jobs created before migration 026.

discovery_truncatedboolean

True when discovery found more unique URLs than max_pages allowed the job to enqueue.

pages_processedinteger
pages_failedinteger
total_chunksinteger
output_urlstring nullable

Signed URL to the final JSONL; present once completed.

error_messagestring nullable
webhook_urlstring nullable

Completion-webhook target registered for this job, if any.

webhook_deliveredboolean

True once the signed completion webhook got a 2xx (H.8).

created_atstring date-time nullable
completed_atstring date-time nullable
warningsstring[]

Changes

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