# Document Structured Extractor (`encouraged_offspring/document-structured-extractor`) Actor

- **URL**: https://apify.com/encouraged\_offspring/document-structured-extractor.md
- **Developed by:** [Lav Chaudhary](https://apify.com/encouraged_offspring) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$50.00 / 1,000 document structured extractor results

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

## Document Structured Extractor

Extract requested fields and source evidence from supported text or public HTML sources.

### Example input

```json
{
  "profile": "invoice",
  "source": {
    "type": "text",
    "text": "Invoice Number: INV-100. Total: $42.00. Due Date: 2026-10-01."
  }
}
```

### Billing

One successful extraction result writes one dataset item and emits exactly one primary pay-per-event event. Validation and execution failures are not charged.

### Safety and limitations

- Limited permissions; Standby disabled; no credentials, wallet access, shell execution, package installation, or arbitrary user code.
- Public URL fetching is bounded by URL validation, SSRF protection, redirect, timeout, and response-size limits. Login, paywalls, cookies, robots bypass, and private networks are not supported.
- Sensitive request content is not logged; review outputs before sharing them.
- This is a deterministic/static or bounded-fetch tool. It does not claim OCR, live CVE coverage, visual WCAG certification, independent fact verification, or runtime API verification unless explicitly stated above.

# Actor input Schema

## `profile` (type: `string`):

Supported extraction profile.

## `source` (type: `object`):

Use text or a public URL. Scanned PDF/image OCR is unsupported.

## `fields` (type: `array`):

Requested fields.

## Actor input object example

```json
{
  "profile": "invoice",
  "fields": [
    {
      "name": "invoiceNumber"
    }
  ]
}
```

# Actor output Schema

## `result` (type: `string`):

Structured Document Structured Extractor result in the default dataset.

# 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 = {
    "profile": "invoice",
    "fields": [
        {
            "name": "invoiceNumber"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("encouraged_offspring/document-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 = {
    "profile": "invoice",
    "fields": [{ "name": "invoiceNumber" }],
}

# Run the Actor and wait for it to finish
run = client.actor("encouraged_offspring/document-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 '{
  "profile": "invoice",
  "fields": [
    {
      "name": "invoiceNumber"
    }
  ]
}' |
apify call encouraged_offspring/document-structured-extractor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,encouraged_offspring/document-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/sZQ9mxbtPRxVu8mxs/builds/r2ZbOz9Jqe0rhKiKe/openapi.json