Skip to main content
POST
Extract structured content

Description

This endpoint extracts structured data from a specified URL based on a user-defined schema. It uses visual and textual information from the webpage to extract the requested data.

Endpoint

Headers

  • Content-Type: application/json
  • Authorization: Bearer <API_KEY> (required)

Request Body

Responses

Success (200)

Returns the extracted data based on the provided schema, along with a URL to the screenshot of the page.
  • Content-Type: application/json
  • X-RateLimit-Limit: The rate limit for the user.
  • X-RateLimit-Remaining: The remaining number of requests for the user.

Bad Request (400)

Returned if the request is invalid.

Internal Server Error (500)

Returned if there’s an error during the extraction process.

Example Request

Example Response

Notes

  • The extraction process uses both visual (screenshot) and textual (HTML) information from the webpage.
  • The extracted data is limited to a single object. Extracting lists of objects may require separate handling.
  • The maximum allowed content for extraction is 100,000 tokens. If the content exceeds this limit, it will be truncated.
  • If the URL doesn’t include a protocol, https:// will be used by default.
  • This endpoint uses 250 credits per request.
  • The extraction is performed using a combination of web scraping and AI-powered analysis (Claude 3 Haiku model).

Rate Limiting

Rate limit headers (X-RateLimit-Limit and X-RateLimit-Remaining) are included in the response to indicate the user’s current rate limit status.

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string<uri>
required

Fully-qualified URL to extract content from.

schema
object
required

JSON schema describing the structure of the extracted data.

requestSource
enum<string>

Optional identifier describing where the API request originated.

Available options:
API,
WEB,
MAKE_DOT_COM,
ZAPIER,
N8N,
PLAYGROUND,
DEFAULT_AUTOMATION,
AGENT_PREVIEW,
AGENT_LIVE,
AUTOPILOT,
STUDIO

Response

Extracted content returned.

screenshotUrl
string<uri>
required

Temporary URL pointing to the captured screenshot of the source page.

results
object
required

Data extracted according to the provided schema.