Skip to content

Last update: October 15, 2026

Quickstart

This guide walks you through making your first call to the Djinn API in a few minutes.

Prerequisites

  • A Djinn API key provided by the Solyntek team (X-API-Key)
  • curl or any HTTP client

Base URL

https://api.dev.djinn.solyntek.io

All endpoints are versioned under /v1/.

The file is sent as multipart/form-data (field file: PDF, DOCX or image, up to 50 MiB). document_type is optional: when omitted, the type is detected.

First Call — Document Extraction

The example below extracts structured data from a PDF invoice.

curl -X POST https://api.dev.djinn.solyntek.io/v1/extract \
  -H "X-API-Key: your_api_key" \
  -F "file=@invoice.pdf" \
  -F "document_type=invoice"

Reading the Response

A successful response (HTTP 200) returns the extracted structured data and a confidence between 0 and 1:

{
  "document_type": "invoice",
  "data": {
    "vendor_name": "Acme SAS",
    "invoice_number": "FAC-2026-0042",
    "invoice_date": "2026-05-01",
    "subtotal": 1041.67,
    "vat_amount": 208.33,
    "total_amount": 1250.00,
    "currency": "EUR"
  },
  "text_source": "native_pdf",
  "confidence": 0.93
}

Supported Document Types

The doc-extract service supports the following values for the document_type field:

Value Description
invoice Vendor invoice
resume Candidate resume
id_card Identity document (national ID card, passport)
receipt Receipt
rib Bank details slip

Next Steps