For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardSign Up
GuidesAPI Reference
  • Getting Started
    • Introduction
    • Authentication
    • Quickstart
  • Concepts
    • Extractors
    • Schemas
LogoLogo
DashboardSign Up
On this page
  • What is Automat?
  • Key Features
  • How it Works
  • Quick Example
  • Next Steps
Getting Started

Introduction

Intelligent document data extraction powered by AI
Was this page helpful?

Authentication

Secure your API requests with API keys
Next
Built with

What is Automat?

Automat is a document intelligence platform that extracts structured data from any document using AI. Define what you want to extract, upload your documents, and get clean, structured JSON back.

Create an Extractor

Define your extraction schema using our visual editor or AI assistant

API Reference

Integrate extraction into your applications with our REST API

Key Features

Schema-based Extraction

Define exactly what fields you need extracted. Automat uses your schema to intelligently locate and extract the data you care about.

Multi-format Support

Extract from PDFs, images (PNG, JPEG, TIFF), and scanned documents. Our AI handles various document layouts and qualities.

Production-ready API

Simple REST API with Bearer token authentication. Integrate in minutes with any programming language.

Model Flexibility

Choose from multiple AI model tiers (Mini, Pro, Max) to balance speed, accuracy, and cost for your use case.

How it Works

  1. Create an Extractor - Define the schema for what data you want to extract
  2. Upload Documents - Send documents via API or the dashboard
  3. Get Structured Data - Receive clean JSON matching your schema

Quick Example

$curl -X POST https://studio.runautomat.com/api/extract \
> -H "Authorization: Bearer YOUR_API_KEY" \
> -F "extractorId=ext_abc123" \
> -F "file=@invoice.pdf"

Response:

1{
2 "data": {
3 "invoice_number": "INV-2024-001",
4 "date": "2024-01-15",
5 "total": 1250.0,
6 "vendor": "Acme Corp",
7 "line_items": [{ "description": "Widget A", "quantity": 10, "price": 100.0 }]
8 }
9}

Next Steps

Authentication

Get your API key

Quickstart

Extract your first document

API Reference

Full API documentation