Skip to content

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.djinn.solyntek.io

All endpoints are versioned under /v1/.

First Call — Document Extraction

The example below extracts structured data from a PDF invoice.

curl -X POST https://api.djinn.solyntek.io/v1/extract \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "file_url": "https://your-storage.example/invoices/invoice-001.pdf",
    "document_type": "invoice"
  }'

Reading the Response

A successful response (HTTP 200) returns the extracted structured data:

{
  "document_id": "ext_01j...",
  "document_type": "invoice",
  "data": {
    "vendor_name": "Acme SAS",
    "invoice_number": "FAC-2026-0042",
    "total_amount": 1250.00,
    "vat_rate": 20.0,
    "issue_date": "2026-05-01"
  },
  "confidence": 0.97
}

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)

Next Steps