ParsXtract

Parse API

Upload en PDF og en templateId, og få udtrukne felter som JSON. Udtræk kan bestå af både regex-felter og bbox-felter (afhængigt af din template).

POST/api/v1/parsemultipart/form-dataAuthorization: Bearer

Overblik

Hvad endpointet gør (og hvad du skal sende)

Input
  • file (PDF)
  • templateId (string)
Auth

Send din API key som Bearer token i Authorization-headeren.

Output

JSON med filnavn, en SHA-256 checksum, og et extracted-map.

Autentificering

Bearer token (API key) via Authorization header

Header
Authorization: Bearer <API_KEY>
Mangler/ugyldige/revokerede nøgler giver 401 Unauthorized.

Request

multipart/form-data felter og constraints

Content-Type

multipart/form-data

I browsers: sæt ikke Content-Type manuelt; browseren tilføjer korrekt boundary.

Form felter
  • file — PDF fil (application/pdf)
  • templateId — ID på en template du ejer

Eksempler

Vælg din foretrukne client

cURL
bash
curl -X POST "https://parsxtract.dk/api/v1/parse" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@C:/path/to/file.pdf;type=application/pdf" \
  -F "templateId=tpl_abc123"

Response (200)

Hvad du får tilbage ved succesfuldt udtræk

Success response
json
{
  "file": "uploaded.pdf",
  "fileSha256": "6b1f... (sha256 af PDF bytes)",
  "extracted": {
    "invoice_number": "INV-12345",
    "total_amount": "1.234,56"
  }
}

Fejl

Typiske statuskoder og payloads

Statuskoder
  • 401 — mangler/ugyldig API key
  • 400 — ugyldig request (mangler felter / ikke PDF / template ugyldig)
  • 400 — forbrugsgrænse nået (kræver upgrade)
Eksempler på error payloads
json
// 401 Unauthorized
{ "error": "Unauthorized" }

// 400 Bad Request (mangler felter / forkert filtype)
{ "error": "'file' and 'templateId' are required" }
{ "error": "Only PDF files are supported" }

// 400 Bad Request (template ikke fundet / forkert ejer)
{ "error": "No valid template provided." }

// 400 Bad Request (forbrug/limit)
{ "error": "Limit reached. Please upgrade to continue extraction." }

Praktiske tips

Små ting der hjælper i produktion

  • Brug templateId fra din konto; templates er user-scoped.
  • Hold PDF’er i en fornuftig størrelse for hurtigere upload og mere stabil drift.
  • I browser-integrationer: sæt ikke Content-Type manuelt for FormData.
  • Overvej caching med fileSha256 + templateId.
Endpoint: POST /api/v1/parse