Skip to main content

Endpoints

EndpointMethodDescription
/v1/extract/POSTExtract structured data from any website using AI-powered extraction with custom JSON schemas.

Data Extraction Endpoint

POST /v1/extract/

Extract specific information from any web page and receive it in a structured JSON format that matches your requirements. Request Parameters:
ParameterTypeRequiredDescription
linkStringYesThe URL of the website to extract data from
promptStringYesInstructions describing what data to extract
json_schemaArrayNoThe structure defining your desired output format. If not provided, returns plain text
delayIntegerNoDelay in seconds before extraction (useful for dynamic content). Default: 0
Example Request:
Response Format (Structured Output):
Response Format (Plain Text - when json_schema is omitted):
FieldTypeDescription
responseArray or StringExtracted data matching your JSON schema (array) or plain text (string) if no schema provided
successBooleanIndicates whether the extraction was successful
Status Codes:
  • 200 OK - Request successful
  • 400 Bad Request - Invalid parameters or malformed JSON schema
  • 401 Unauthorized - Invalid or missing API key
  • 404 Not Found - URL not accessible
Error Response: