# AI Structured Data Extractor - Any Website to JSON (`itsoul/ai-structured-extractor`) Actor

Turn any web page into clean JSON that matches your own schema using AI. No CSS selectors needed. Pay only per page extracted.

- **URL**: https://apify.com/itsoul/ai-structured-extractor.md
- **Developed by:** [Mahmoud Alhamdo](https://apify.com/itsoul) (community)
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $5.00 / 1,000 page extracteds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## AI Structured Data Extractor – Any Website to JSON

Turn any web page into clean JSON that matches **your own schema**. Describe the fields you want, paste URLs, and get structured data back. No CSS selectors, no maintenance when a site changes its layout.

### What can it do?

- Extract products, listings, articles, contacts, job posts, events or any other page content.
- Return exactly the fields you define, with correct types (string, number, boolean, arrays).
- Feed AI agents, RAG pipelines, spreadsheets, CRMs or databases with clean data.
- Works with n8n, Make, Zapier and the Apify API.

### How to use it

1. Add one or more URLs.
2. Paste a JSON Schema that describes the output (a ready example is prefilled).
3. Optionally add instructions such as "prices in USD".
4. Run and download JSON, CSV or Excel.

### Input example

```json
{
  "startUrls": [{ "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html" }],
  "schema": {
    "type": "object",
    "properties": {
      "title": { "type": "string" },
      "price": { "type": "number" },
      "in_stock": { "type": "boolean" }
    }
  }
}
```

### Output example

```json
{
  "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
  "success": true,
  "data": { "title": "A Light in the Attic", "price": 51.77, "in_stock": true }
}
```

### Pricing

You pay per page successfully extracted (pay per event). Failed pages are not charged. Set a maximum spend per run in the run options to control cost.

### Limits

- Reads static HTML. Pages that render content only with JavaScript may return a "no readable text" error.
- Page text is truncated to the configured length before extraction.
- Fields not present on the page are returned as `null`; the AI does not invent values.

### Responsible use

Only extract data you are allowed to collect. Respect each site's terms of service and applicable privacy laws such as GDPR.

# Actor input Schema

## `startUrls` (type: `array`):

Pages to extract data from. Each page is processed separately.

## `schema` (type: `object`):

JSON Schema describing the data you want from each page. Use type "object" with "properties".

## `instructions` (type: `string`):

Optional hints, e.g. 'prices in USD' or 'only the main product'.

## `maxPages` (type: `integer`):

Hard cap on pages processed per run.

## `maxContentChars` (type: `integer`):

Page text is truncated to this many characters before AI extraction.

## `proxyConfiguration` (type: `object`):

Optional. Enable a proxy for sites that block direct requests.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
    }
  ],
  "schema": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string"
      },
      "price": {
        "type": "number"
      },
      "in_stock": {
        "type": "boolean"
      },
      "description": {
        "type": "string"
      }
    }
  },
  "maxPages": 50,
  "maxContentChars": 30000,
  "proxyConfiguration": {}
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        {
            "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
        }
    ],
    "schema": {
        "type": "object",
        "properties": {
            "title": {
                "type": "string"
            },
            "price": {
                "type": "number"
            },
            "in_stock": {
                "type": "boolean"
            },
            "description": {
                "type": "string"
            }
        }
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("itsoul/ai-structured-extractor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "startUrls": [{ "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html" }],
    "schema": {
        "type": "object",
        "properties": {
            "title": { "type": "string" },
            "price": { "type": "number" },
            "in_stock": { "type": "boolean" },
            "description": { "type": "string" },
        },
    },
}

# Run the Actor and wait for it to finish
run = client.actor("itsoul/ai-structured-extractor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    {
      "url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
    }
  ],
  "schema": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string"
      },
      "price": {
        "type": "number"
      },
      "in_stock": {
        "type": "boolean"
      },
      "description": {
        "type": "string"
      }
    }
  }
}' |
apify call itsoul/ai-structured-extractor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,itsoul/ai-structured-extractor"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/gDCx4On1edDC0Mu9D/builds/y0hhrZ7qJHlKdaF7b/openapi.json