API Reference

Extract

POST/v1/extract
Try in Playground

Authorization

Use your API key as a bearer token.

Authorization: Bearer qk_your_api_key

Request Body

application/json
FieldTypeRequiredDescription
urlstringRequiredThe URL to fetch and extract relevant chunks from.
querystringRequiredWhat information to extract from the page content.
format"markdown" | "json"OptionalOutput format for extracted chunks. Defaults to `markdown`.
use_safeguardbooleanOptionalEnable prompt-injection detection on selected extracted content.

Response

Successful response payload from the OpenAPI schema.

FieldTypeRequiredDescription
resultstring | string[]RequiredBy format: markdown: Relevant chunks markdown | json: Relevant chunks array.
unsafebooleanOptionalTrue when safeguard marks content as unsafe.

Pricing

Base cost: 1 credit • With safeguard: 2 credits