v2
v2-perceive

Perceive

Single-URL perception: render once, return every requested output.

With direct_download=true the response body IS the artifact bytes (metadata rides in X- headers) — no second fetch to a signed URL.

post/v2/perceive

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/perceive
  • Auth: none declared

Headers

X-API-Keystring nullable
authorizationstring nullable

Request body

outputsstring[]
only_main_contentboolean

When true (default), the markdown output and the main_content extract strip 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 content is kept with no stripping.

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: on when the page is being curated, off when the caller asked for the page as-is. Set true/false to control it explicitly.

allow_degradedboolean

Deprecated and ignored. A content-free anti-bot block now always returns 200 with is_blocked=true, the render-quality deductions and no artifacts (it is not billed). Sending true adds a deprecation warning to the response.

direct_downloadboolean

When true, the response body IS the artifact bytes (no second fetch to a signed URL). Requires exactly one artifact-producing output. Not available on the batch endpoint (use output_mode='zip' there).

extractstring[]
schemaobject nullable

JSON schema for structured extraction (Tier-3 LLM path lands in Sprint F.6; accepted and stored today).

wait_forstring nullable

CSS selector (optionally 'css:...') or 'js:<expr>' to await after navigation.

wait_timeout_msinteger
js_codestring nullable
headersobject nullable
cookiesobject[] nullable
proxy_urlstring nullable

Business+; not yet available (422).

geolocationobject nullable

Not yet available (422).

action_chainobject[] nullable

Not yet available (422).

cache_mode'enabled' | 'bypass' | 'refresh'
block_resourcesstring[]
respect_robotsboolean
mobileboolean
urlstring required

Response

Successful Response

operation_idstring required
status'queued' | 'processing' | 'completed' | 'failed' required
urlstring required
url_finalstring nullable
content_hashstring nullable
status_codeinteger nullable

HTTP status of the final main-document response (e.g. 200, 404). None when the engine could not observe it.

render_qualitynumber nullable

0.0-1.0; populated by the F.7 scorer.

deductionsobject

Named render-quality deductions that fired for this render (e.g. {'http_error': 0.7}). Empty on a clean render.

is_blockedboolean

True when the scorer judged the render an anti-bot challenge or WAF block page. A block with no page content behind it returns 200 with this flag set and outputs={}.

billedboolean

Whether this operation consumed one op from the monthly quota. False for blocked reads and for renders whose deductions include http_error or login_wall; cache hits bill.

options_echoobject nullable

Echo of the request options the server honoured (secrets redacted to booleans), so a caller can verify what was actually applied.

cache_hitboolean
outputsobject
structuredobject nullable
extraction_tier'heuristic' | 'css' | 'llm' nullable
cost_centsnumber
duration_msinteger nullable
errorstring nullable
warningsstring[]

Changes

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