API-referens

Ett REST API för att extrahera strukturerad data från dokument. Skicka en fil, få tillbaka strukturerad JSON.

Skaffa API-nyckel gratis →Visa fullständig dokumentation → Postman

Postman-samling

REST APIJSON-svarWebhooks60+ språk

Autentisering

Alla förfrågningar kräver en X-API-Key -rubrik. Hämta din nyckel från Inställningar → API i ditt Airparser-konto.

cURL

curl https://api.airparser.com/inboxes \
  -H "X-API-Key: YOUR_API_KEY"

Förvara din API-nyckel säkert — behandla den som ett lösenord.

Analysera dokument

Ladda upp en fil och få tillbaka fullständigt extraherad data i en enda synkron förfrågan — inga webhooks, ingen pollning, inget andra anrop. Svaret innehåller alla extraherade fält som strukturerad JSON, redo att användas direkt i ditt arbetsflöde.

POST/inboxes/{inbox_id}/upload-syncAPI-dokumentation →

curl \
  -X POST \
  https://api.airparser.com/inboxes/<INBOX_ID>/upload-sync \
  -F 'file=@./receipt.pdf' \
  -H "X-API-Key: <YOUR_API_KEY>"import requests

header = {"X-API-Key": "<API_KEY>"}
url = "https://api.airparser.com/inboxes/<INBOX_ID>/upload-sync"

with open('invoice.pdf', 'rb') as f:
    files = {'file': f}
    with requests.request("POST", url, files=files, headers=header) as response:
        print('response: ', response)const fetch = require("node-fetch");
const fs = require("fs");
const FormData = require("form-data");

const APIKEY = "<YOUR_API_KEY>";
const inboxId = "<INBOX_ID>";
const filePath = "/path/to/your/file.pdf";
const metadata = { foo: "bar" };

async function parseDocument(inboxId, filePath, metadata) {
  const url = `https://api.airparser.com/inboxes/${inboxId}/upload-sync`;

  const fileStream = fs.createReadStream(filePath);

  const form = new FormData();
  form.append("file", fileStream);
  form.append("meta", JSON.stringify(metadata));

  try {
    const response = await fetch(url, {
      method: "POST",
      body: form,
      headers: {
        "X-API-Key": APIKEY,
      },
    });

    const docId = await response.json();
    console.log(response.status);
    console.log("Document id:", docId);
  } catch (e) {
    console.error("Error:", e.message);
  }
}

parseDocument(inboxId, filePath, metadata);<?php

$apikey = '<API_KEY>';
$url = 'https://api.airparser.com/inboxes/<INBOX_ID>/upload-sync';
$filepath = './invoice.pdf';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'X-API-Key: ' . $apikey
));
curl_setopt($curl, CURLOPT_POST, true);

$meta = array(
  'foo' => 'bar',
  'my_id' => 42,
);
$metaJson = json_encode($meta);

curl_setopt($curl, CURLOPT_POSTFIELDS, array(
    'file' => curl_file_create($filepath, 'application/pdf', 'invoice.pdf'),
    'meta' => $metaJson
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Svar200 OK

{
  "doc_id": "64abc123def456...",
  "parsing_in_progress": false,
  "status": "parsed",
  "name": "invoice.pdf",
  "content_type": "application/pdf",
  "created_at": "2026-03-10T12:00:00.000Z",
  "processed_at": "2026-03-10T12:00:04.321Z",
  "json": {
    "invoice_number": "INV-001",
    "vendor": "Acme Corp",
    "total": 1250.00,
    "currency": "USD",
    "date": "2024-01-15"
  }
}

Hämta extraherad data

Hämta ett dokument via ID för att få dess extraktionsstatus och resultat. Polla denna slutpunkt eller använd webhooks för att veta när bearbetningen är klar.

GET/documents/{document_id}

cURL

curl https://api.airparser.com/documents/doc_abc123 \
  -H "X-API-Key: YOUR_API_KEY"

Svar200 OK

{
  "doc_id": "64abc123def456...",
  "parsing_in_progress": false,
  "status": "parsed",
  "name": "invoice.pdf",
  "content_type": "application/pdf",
  "created_at": "2026-03-10T12:00:00.000Z",
  "processed_at": "2026-03-10T12:00:04.321Z",
  "json": {
    "invoice_number": "INV-001",
    "vendor": "Acme Corp",
    "total": 1250.00,
    "date": "2024-01-15"
  }
}

Definiera extraktionsschema

Definiera vilka fält som ska extraheras. Stöder skalära fält, listor (för radposter) och uppräkningar.

POST/inboxes/{inbox_id}/schema

{
  "fields": [
    {
      "type": "scalar",
      "data": {
        "name": "invoice_number",
        "description": "Invoice reference number",
        "type": "string",
        "default_value": ""
      }
    },
    {
      "type": "list",
      "data": {
        "name": "items",
        "description": "List of items in the invoice",
        "attributes": [
          {
            "name": "description",
            "description": "Item description",
            "type": "string",
            "default_value": ""
          },
          {
            "name": "amount",
            "description": "Item amount",
            "type": "decimal",
            "default_value": "0.00"
          }
        ]
      }
    },
    {
      "type": "enum",
      "data": {
        "name": "payment_status",
        "description": "Current payment status",
        "values": ["paid", "pending", "overdue"]
      }
    }
  ]
}

Efterbehandling

Kör Python-kod på extraherad data innan den skickas till integrationer. Lägg till affärslogik, sammanfoga fält, formatera värden.

Sammanfoga fält

# Merge first and last name into full name
data['fullname'] = data['first_name'] + " " + data['last_name']

# Using f-strings (recommended)
data["fullname"] = f"{data['first_name']} {data['last_name']}"

# Using format() function
data['fullname'] = '{} {}'.format(data['first_name'], data['last_name'])

Villkorslogik

# Only process invoices above certain amount
if float(data.get('total_amount', 0)) > 1000:
    data['priority'] = 'high'
else:
    data['priority'] = 'normal'

# Add timestamp
import datetime
data['processed_at'] = datetime.datetime.now().isoformat()

Utforska avancerade efterbehandlingstekniker och exempel:

Efterbehandlingsguide →Kodexempel →

Webhooks

Airparser skickar en POST -förfrågan till din slutpunkt när extraktionen är klar. Svara med 200 för att bekräfta.

Installationssteg

1 Kopiera din webhook-slutpunkts-URL från din server eller en tjänst som ngrok.
2 Gå till Integrationer → Webhooks i ditt Airparser-konto.
3 Klicka på "Create a webhook" och klistra in din slutpunkts-URL.
4 Testa webhooken med ett exempeldokument för att verifiera integrationen.

import json
from flask import Flask, request

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def webhook():
    payload = request.data
    data = json.loads(payload)

    # Process the parsed data
    # data contains all extracted fields

    return {'success': True}

if __name__ == '__main__':
    app.run(port=4242)const express = require('express');
const app = express();

app.post('/webhook', express.raw({type: 'application/json'}), (request, response) => {
  const payload = request.body;
  const data = JSON.parse(payload);

  // Process the parsed data
  // data contains all extracted fields

  // Return 200 to acknowledge receipt
  response.send();
});

app.listen(4242, () => console.log('Running on port 4242'));<?php
$payload = @file_get_contents('php://input');
$data = json_decode($payload, true);

// Process the parsed data
// $data contains all extracted fields

// Always return 200 to acknowledge receipt
http_response_code(200);
echo "OK";

Resurser

Letar du efter en icke-teknisk översikt? Läs Vad är ett API för dokumentextraktion — täcker konceptet, användningsfall och hur Airparsers API fungerar utan kodexempel.

Fullständig API-dokumentation

Komplett API-referens med alla slutpunkter, parametrar och exempel.

Snabbstart

Följ vår steg-för-steg-guide för att komma igång på minuter.

Efterbehandlingsguide

Lär dig att transformera extraherad data med Python-skript.