Iteration Layer
Products
Use Cases
Resources
Pricing
Login Get Started

Getting Started

Welcome to the Iteration Layer API documentation. This guide will help you get up and running in minutes.

Quick Start

1. Create an Account

Sign up at iterationlayer.com to create your account. You’ll receive free trial credits for each API to get started. Generate a global API key from the API Keys page — keys work across all APIs.

2. Make Your First Request

Request
curl -X POST \
  https://api.iterationlayer.com/document-extraction/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "files": [
      {
        "type": "url",
        "name": "invoice.pdf",
        "url": "https://example.com/invoice.pdf"
      }
    ],
    "schema": {
      "fields": [
        {
          "name": "invoice_number",
          "type": "TEXT"
        },
        {
          "name": "total_amount",
          "type": "CURRENCY_AMOUNT"
        }
      ]
    }
  }'
Response
{
  "success": true,
  "data": {
    "invoice_number": {
      "type": "TEXT",
      "value": "INV-2024-0042",
      "confidence": 0.97,
      "citations": [
        "Invoice #INV-2024-0042"
      ],
      "source": "invoice.pdf"
    },
    "total_amount": {
      "type": "CURRENCY_AMOUNT",
      "value": 1250.00,
      "confidence": 0.95,
      "citations": [
        "Total: €1,250.00"
      ],
      "source": "invoice.pdf"
    }
  }
}
Request
import { IterationLayer } from "iterationlayer";
const client = new IterationLayer({
  apiKey: "YOUR_API_KEY",
});

const result = await client.extract({
  files: [
    {
      type: "url",
      name: "invoice.pdf",
      url: "https://example.com/invoice.pdf",
    },
  ],
  schema: {
    fields: [
      {
        name: "invoice_number",
        type: "TEXT",
        description: "The invoice number",
      },
      {
        name: "total_amount",
        type: "CURRENCY_AMOUNT",
        description: "Total invoice amount",
      },
    ],
  },
});
Response
{
  "success": true,
  "data": {
    "invoice_number": {
      "type": "TEXT",
      "value": "INV-2024-0042",
      "confidence": 0.97,
      "citations": [
        "Invoice #INV-2024-0042"
      ],
      "source": "invoice.pdf"
    },
    "total_amount": {
      "type": "CURRENCY_AMOUNT",
      "value": 1250.00,
      "confidence": 0.95,
      "citations": [
        "Total: €1,250.00"
      ],
      "source": "invoice.pdf"
    }
  }
}
Request
from iterationlayer import IterationLayer
client = IterationLayer(api_key="YOUR_API_KEY")

result = client.extract(
    files=[
        {
            "type": "url",
            "name": "invoice.pdf",
            "url": "https://example.com/invoice.pdf",
        }
    ],
    schema={
        "fields": [
            {
                "name": "invoice_number",
                "type": "TEXT",
                "description": "The invoice number",
            },
            {
                "name": "total_amount",
                "type": "CURRENCY_AMOUNT",
                "description": "Total invoice amount",
            },
        ],
    },
)
Response
{
  "success": true,
  "data": {
    "invoice_number": {
      "type": "TEXT",
      "value": "INV-2024-0042",
      "confidence": 0.97,
      "citations": [
        "Invoice #INV-2024-0042"
      ],
      "source": "invoice.pdf"
    },
    "total_amount": {
      "type": "CURRENCY_AMOUNT",
      "value": 1250.00,
      "confidence": 0.95,
      "citations": [
        "Total: €1,250.00"
      ],
      "source": "invoice.pdf"
    }
  }
}
Request
import il "github.com/iterationlayer/sdk-go"
client := il.NewClient("YOUR_API_KEY")

result, err := client.Extract(il.ExtractRequest{
    Files: []il.FileInput{
        il.NewFileFromURL(
            "invoice.pdf",
            "https://example.com/invoice.pdf",
        ),
    },
    Schema: il.ExtractionSchema{
        "invoice_number": il.NewTextFieldConfig(
            "invoice_number",
            "The invoice number",
        ),
        "total_amount": il.NewCurrencyAmountFieldConfig(
            "total_amount",
            "Total invoice amount",
        ),
    },
})
Response
{
  "success": true,
  "data": {
    "invoice_number": {
      "type": "TEXT",
      "value": "INV-2024-0042",
      "confidence": 0.97,
      "citations": [
        "Invoice #INV-2024-0042"
      ],
      "source": "invoice.pdf"
    },
    "total_amount": {
      "type": "CURRENCY_AMOUNT",
      "value": 1250.00,
      "confidence": 0.95,
      "citations": [
        "Total: €1,250.00"
      ],
      "source": "invoice.pdf"
    }
  }
}

3. Explore the APIs

Switching from Another Tool?

See how Iteration Layer compares to the tools you may already be using.

Document Extraction

Document to Markdown

Image Transformation

Image Generation

Document Generation

Sheet Generation