POST
/
extract

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
urls
required

The URL to extract content from.

extract_depth
enum<string>
default:
basic

The depth of the extraction process. You may experience higher latency with advanced extraction, but it offers a higher success rate and retrieves more data from the URL (e.g., tables, embedded content). basic extraction costs 1 API Credit per 5 successful URL extractions, while advanced extraction costs 2 API Credits per 5 successful URL extractions.

Available options:
basic,
advanced
include_images
boolean
default:
false

Include a list of images extracted from the URLs in the response. Default is false.

Response

200 - application/json
failed_results
object[]

A list of URLs that could not be processed.

response_time
number

Time in seconds it took to complete the request.

results
object[]

A list of extracted content from the provided URLs.