v1

latestOpenAPI 3.1.02026-07-136138.4 KB
Extract

AI-Powered Structured Extraction

Extract structured data from web pages using AI. Define your desired output structure with JSON Schema, and our AI will intelligently extract the information.

Use Cases:

  • Extract product information from e-commerce pages
  • Parse job listings into structured format
  • Extract contact information and business details
  • Convert news articles into structured data
  • Scrape pricing tables and specifications

How It Works:

  1. Provide a URL and a JSON Schema defining your desired structure
  2. Our AI analyzes the page content
  3. Extracts data matching your schema
  4. Returns validated JSON output

Schema Definition:

Use JSON Schema to define your desired output structure:

  • Field types: string, number, boolean, array, object
  • Field descriptions: Help the AI understand what to extract
  • Required fields: Mark critical fields as required
  • Nested structures: Support for complex, nested data

Example Schema:

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Product name or title"
    },
    "price": {
      "type": "number",
      "description": "Current price in USD"
    },
    "availability": {
      "type": "boolean",
      "description": "Whether the product is in stock"
    },
    "features": {
      "type": "array",
      "items": {"type": "string"},
      "description": "List of key product features"
    }
  },
  "required": ["title", "price"]
}
post/extract

Request body

urlstring required

The URL of the web page to extract data from

schemaobject required

Data structure definition in JSON Schema format

timeoutnumber

Request timeout in milliseconds, default 30000

Example request

{
  "url": "https://example.com/product",
  "schema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "description": "Product name"
      },
      "price": {
        "type": "number",
        "description": "Product price"
      },
      "currency": {
        "type": "string",
        "description": "Currency unit"
      }
    },
    "required": [
      "name",
      "price"
    ]
  }
}

Response

Success response

successboolean

Example response

{
  "success": true,
  "data": {
    "url": "https://example.com/product",
    "extract": {
      "name": "iPhone 15 Pro",
      "price": 999,
      "currency": "USD",
      "availability": true,
      "rating": 4.7,
      "reviewCount": 1253,
      "description": "Apple's latest flagship smartphone featuring the powerful A17 Pro chip, advanced camera system with 5x optical zoom, and titanium design.",
      "features": [
        "A17 Pro chip with 6-core GPU",
        "Pro camera system with 48MP main camera",
        "Titanium design with textured matte glass",
        "Action button for quick access",
        "USB-C connectivity",
        "Up to 29 hours video playback"
      ],
      "specifications": [
        {
          "category": "Display",
          "items": [
            {
              "key": "Screen Size",
              "value": "6.1 inches"
            },
            {
              "key": "Resolution",
              "value": "2556 x 1179"
            },
            {
              "key": "Type",
              "value": "Super Retina XDR OLED"
            }
          ]
        },
        {
          "category": "Storage & Memory",
          "items": [
            {
              "key": "Storage Options",
              "value": "128GB, 256GB, 512GB, 1TB"
            },
            {
              "key": "RAM",
              "value": "8GB"
            }
          ]
        }
      ],
      "images": [
        "https://example.com/iphone-front.jpg",
        "https://example.com/iphone-back.jpg"
      ],
      "variants": [
        {
          "color": "Natural Titanium",
          "available": true
        },
        {
          "color": "Blue Titanium",
          "available": true
        },
        {
          "color": "White Titanium",
          "available": false
        },
        {
          "color": "Black Titanium",
          "available": true
        }
      ]
    },
    "metadata": {
      "sourceURL": "https://example.com/product/iphone-15-pro",
      "statusCode": 200,
      "extractedAt": "2024-01-15T14:30:00Z",
      "confidence": 0.95,
      "processingTime": 3450
    }
  }
}