PapyDocs mpo na ba développeurs

API ya Papy ememaka mosala ya mikanda ya PapyDocs na ba applications, ba sites mpe ba logiciels na yo na nzela ya interface REST ya pete oyo ezali na ba versions.

Endpoint moko na moko oyo elimbolami esalelaka ba moteurs ndenge moko na bisaleli ya PapyDocs.
Ba fungola ebombamaka lokola bilembo (hachage), elakisamaka mbala moko kaka, mpe ekoki kobongolama to kolongolama.
Mikanda esalemaka na mémoire mpe ebombamaka soko moke te; kaka ba compteurs ya bosaleli nde ebombamaka.

Kotalela soki ezali…

Kobanda noki

Senga fungola ya API epai ya mokambi ya esika oyo ya PapyDocs (esalemaka na « Ba fungola mpe bosaleli » awa na nse).
Tinda bosenga POST multipart/form-data na /api/v1/OPERATION elongo na ba PDF mpe ba paramètres na yo.
Bakisa en-tête Authorization: Bearer YOUR_KEY na bosenga moko na moko.
Tanga résultat JSON, to bomba PDF to ZIP oyo ezongisami. Mabunga ezongaka ntango nyonso na JSON elongo na code oyo ebongwanaka te.

Lakisa misala oyo ezali na esika oyo

curl https://papydocs.vercel.app/api/v1

Bondimisi (authentification)

Bosenga moko na moko endimisamaka na fungola ya API oyo etindami na en-tête Authorization.

HTTP

Authorization: Bearer papy_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

PapyDocs ebombaka kaka elembo SHA-256 ya fungola moko na moko, fungola yango moko soko moke te.
Fungola ya sika elakisamaka mbala moko kaka, ntango esalemi. Bomba yango na esika ya sekele na yo: ekoki kolakisama lisusu te.
Bobongoli epesaka fungola ya sika mpe elongolaka ya kala mbala moko; bolongoli esalaka banda bosenga oyo elandi.
Benga API uta na serveur na yo. Tia soko moke te fungola na lokasa ya web to na application ya telefone.

Liste ya ba endpoints

Misala nyonso ezali ba bosenga POST na /api/v1/OPERATION elongo na nzoto multipart/form-data. Misala ya JSON ezongisaka application/json; misala ya mikanda ezongisaka PDF to ZIP mbala moko.

Misala na mikanda

POST`/api/v1/info`— Bansango ya mokanda

Ezongisaka motango ya nkasa, bonene mpe ba métadonnées ya PDF.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/info" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf"

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/info", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/info",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "pages": 2,
  "bytes": 48213,
  "metadata": {
    "title": "Contract",
    "author": "",
    "subject": "",
    "keywords": "",
    "creator": "",
    "producer": "pdf-lib",
    "creationDate": "2026-10-14T09:00:00.000Z",
    "modificationDate": null,
    "customKeys": [],
    "hasXmp": false,
    "hasJavaScript": false,
    "hasEmbeddedFiles": false,
    "pageCount": 2
  }
}

POST`/api/v1/merge`— Kosangisa

Esangisaka ba PDF mingi na molongo oyo etindami.

Esika	Lolenge	Esengeli
files	Mikanda mingi ya PDF	Iyo

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/merge" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "files=@document.pdf" \
  -F "files=@other.pdf" \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("files", await openAsBlob("document.pdf"), "document.pdf");
form.append("files", await openAsBlob("other.pdf"), "other.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/merge", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/merge",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("files", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ("files", ("other.pdf", open("other.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

POST`/api/v1/split`— Kokabola

Ekabolaka PDF na biteni ya nkasa (ndakisa 1-2,5) to mokanda moko mpo na lokasa moko; ezongisaka ZIP.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
mode	Moko kati na (ranges \| every-page)	Te
ranges	Makomi	Te

Eyano: Archive ZIP ya ba PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/split" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'mode=ranges' \
  -F 'ranges=1-2,5' \
  -o result.zip

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("mode", "ranges");
form.append("ranges", "1-2,5");

const response = await fetch("https://papydocs.vercel.app/api/v1/split", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.zip", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/split",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"mode": "ranges", "ranges": "1-2,5"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.zip", "wb") as out:
    out.write(response.content)

POST`/api/v1/compress`— Kokomisa moke

Bobongisi ya PDF kozanga kobebisa (bililingi ebongolamaka te).

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/compress" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/compress", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/compress",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

POST`/api/v1/rotate`— Kobalusa

Ebalusaka nkasa nyonso na 90, 180 to 270 degrés.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
angle	Moko kati na (90 \| 180 \| 270)	Te

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/rotate" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'angle=90' \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("angle", "90");

const response = await fetch("https://papydocs.vercel.app/api/v1/rotate", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/rotate",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"angle": "90"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

POST`/api/v1/page-numbers`— Mitango ya nkasa

Ebakisaka mitango ya nkasa uta na modèle oyo esalelaka ba variables {page} mpe {total} (minkoko ya Latin).

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
format	Makomi	Te
start	Motango	Te

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/page-numbers" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'format={page} / {total}' \
  -F 'start=1' \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("format", "{page} / {total}");
form.append("start", "1");

const response = await fetch("https://papydocs.vercel.app/api/v1/page-numbers", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/page-numbers",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"format": "{page} / {total}", "start": "1"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

POST`/api/v1/watermark`— Elembo ya mai (filigrane)

Ebakisaka filigrane ya makomi na diagonale na lokasa moko na moko (minkoko ya Latin).

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
text	Makomi	Iyo
opacity	Motango	Te

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/watermark" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'text=CONFIDENTIAL' \
  -F 'opacity=0.2' \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("text", "CONFIDENTIAL");
form.append("opacity", "0.2");

const response = await fetch("https://papydocs.vercel.app/api/v1/watermark", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/watermark",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"text": "CONFIDENTIAL", "opacity": "0.2"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

Mayele ya mikanda

POST`/api/v1/text`— Kobimisa makomi

Ezongisaka makomi ya lokasa moko na moko mpe elakisaka soki mokanda ezali lokola ya scanner (needsOcr). OCR esalemaka te na serveur.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/text" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf"

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/text", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/text",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "pages": [
    {
      "page": 1,
      "text": "Facture N° FAC-2026-0042\nTotal TTC 144,00 €"
    }
  ],
  "characters": 41,
  "needsOcr": false
}

POST`/api/v1/search`— Koluka na ba PDF mingi

Boluki ya makomi na kati ya ba PDF oyo etindami: ba résultats na mokanda, lokasa, mbala mpe eteni oyo ekopiami uta na lokasa. Salelá ba guillemets mpo na maloba ya sika.

Esika	Lolenge	Esengeli
files	Mikanda mingi ya PDF	Iyo
query	Makomi	Iyo

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/search" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "files=@document.pdf" \
  -F "files=@other.pdf" \
  -F 'query="notice period"'

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("files", await openAsBlob("document.pdf"), "document.pdf");
form.append("files", await openAsBlob("other.pdf"), "other.pdf");
form.append("query", "\"notice period\"");

const response = await fetch("https://papydocs.vercel.app/api/v1/search", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/search",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("files", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ("files", ("other.pdf", open("other.pdf", "rb"), "application/pdf")),
    ],
    data={"query": "\"notice period\""},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "query": "\"notice period\"",
  "results": [
    {
      "document": "contract.pdf",
      "documentIndex": 0,
      "page": 2,
      "score": 6,
      "occurrences": 1,
      "snippet": {
        "before": "…may terminate with a ",
        "match": "notice period",
        "after": " of three months…"
      }
    }
  ]
}

POST`/api/v1/invoice`— Kobimisa ba données ya ba factures

Ebimisaka moteki, mosombi, motango, ba dati, devise, mbongo, milongo ya biloko, mibeko ya kofuta mpe référence ya commande, moko na moko na lokasa mpe molongo esika euti, elongo na botaleli ya boyokani. Mituya oyo ezangi ezongaka lokola null, ekanisamaka soko moke te.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/invoice" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf"

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/invoice", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/invoice",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "fields": {
    "invoiceNumber": {
      "value": "FAC-2026-0042",
      "status": "found",
      "source": {
        "pageNumber": 1,
        "excerpt": "Facture N° FAC-2026-0042"
      }
    },
    "total": {
      "value": "144",
      "status": "found",
      "source": {
        "pageNumber": 1,
        "excerpt": "Total TTC 144,00 €"
      }
    },
    "dueDate": {
      "value": null,
      "status": "missing",
      "source": null
    }
  },
  "lineItems": [
    {
      "description": "Ramette papier A4",
      "quantity": 10,
      "unitPrice": 5,
      "amount": 50,
      "source": {
        "pageNumber": 1,
        "excerpt": "Ramette papier A4 10 5,00 € 50,00 €"
      }
    }
  ],
  "checks": [
    {
      "code": "missing",
      "field": "dueDate"
    }
  ]
}

POST`/api/v1/contract`— Kotalela kontra

Ezongisaka mitó ya ba clauses, biteni na kolanda makambo (bato ya kontra, bofuti, ntango, bosukisi…), ba dati, mbongo, ba préavis mpe biteni ya kotalela, nyonso ekopiami uta na mokanda elongo na lokasa na yango. Bilembo na maloba ya ntina, toli ya mibeko te.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/contract" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf"

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/contract", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/contract",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "notice": "Passages are copied from the document; categories and flags are keyword-based pointers to verify, not legal advice.",
  "pageCount": 2,
  "clauses": [
    {
      "heading": "Article 7 - Résiliation",
      "pageNumber": 2
    }
  ],
  "findings": [
    {
      "category": "termination",
      "pageNumber": 2,
      "clause": "Article 7 - Résiliation",
      "excerpt": "Chaque partie peut résilier le contrat moyennant un préavis de 3 mois."
    }
  ],
  "flags": [
    {
      "reason": "auto-renewal",
      "pageNumber": 1,
      "clause": "Article 2 - Durée",
      "excerpt": "Il est renouvelé par tacite reconduction…",
      "match": "tacite reconduction"
    }
  ],
  "facts": [
    {
      "type": "notice",
      "value": "préavis de 3 mois",
      "pageNumber": 2,
      "clause": "Article 7 - Résiliation",
      "excerpt": "…"
    }
  ],
  "sentenceCount": 14
}

POST`/api/v1/compare`— Kokanisa ba versions mibale

Ekokanisaka makomi ya ba PDF mibale lokasa na lokasa mpe ezongisaka biteni oyo ebakisami, elongolami mpe ebongwani elongo na fraze na yango.

Esika	Lolenge	Esengeli
original	Mokanda PDF	Iyo
revised	Mokanda PDF	Iyo

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/compare" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "original=@contract-v1.pdf" \
  -F "revised=@contract-v2.pdf"

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("original", await openAsBlob("contract-v1.pdf"), "contract-v1.pdf");
form.append("revised", await openAsBlob("contract-v2.pdf"), "contract-v2.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/compare", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/compare",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("original", ("contract-v1.pdf", open("contract-v1.pdf", "rb"), "application/pdf")),
    ("revised", ("contract-v2.pdf", open("contract-v2.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "identical": false,
  "pageCountOriginal": 2,
  "pageCountRevised": 2,
  "wordsAdded": 11,
  "wordsRemoved": 1,
  "changes": [
    {
      "type": "modified",
      "pageNumber": 1,
      "before": "12",
      "after": "24",
      "context": "Le contrat est conclu pour une durée de 24 mois."
    }
  ]
}

POST`/api/v1/proofread`— Kobongisa

Esalelaka mibeko ya bobongisi ya kati ya PapyDocs (ba espaces, ponctuation, maloba oyo ezongeli, minkoko ya mikonzi, mabunga oyo emonanaka mingi) mpe ezongisaka likama moko na moko elongo na bobongisi mpe esika na yango.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
language	Moko kati na (auto \| fr \| en \| es \| pt)	Te

Eyano: JSON

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/proofread" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'language=auto'

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("language", "auto");

const response = await fetch("https://papydocs.vercel.app/api/v1/proofread", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
const data = await response.json();
console.log(data);

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/proofread",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"language": "auto"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
print(response.json())

Ndakisa ya eyano (ekomami mokuse)

{
  "language": "fr",
  "engine": "local-rules",
  "issues": [
    {
      "page": 1,
      "start": 11,
      "end": 15,
      "original": "recu",
      "suggestion": "reçu",
      "category": "spelling",
      "rule": "misspelling"
    }
  ]
}

Bokengi mpe sekele

POST`/api/v1/remove-metadata`— Kolongola ba métadonnées

Elongolaka ba métadonnées ya mokanda mpe biloko oyo esalaka (JavaScript, mikanda oyo ekotisami).

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/remove-metadata" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");

const response = await fetch("https://papydocs.vercel.app/api/v1/remove-metadata", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/remove-metadata",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

POST`/api/v1/protect`— Kobatela na mot de passe

Ebombaka PDF na sekele (AES-256) na mot de passe ya kofungola.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
password	Makomi	Iyo
owner_password	Makomi	Te

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/protect" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'password=your-password' \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("password", "your-password");

const response = await fetch("https://papydocs.vercel.app/api/v1/protect", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/protect",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"password": "your-password"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

POST`/api/v1/unlock`— Kolongola mot de passe

Efungolaka PDF soki mot de passe ya malamu epesami.

Esika	Lolenge	Esengeli
file	Mokanda PDF	Iyo
password	Makomi	Iyo

Eyano: Mokanda PDF

Bandakisa ya code mpe ya eyano

cURL

curl -X POST "https://papydocs.vercel.app/api/v1/unlock" \
  -H "Authorization: Bearer $PAPY_API_KEY" \
  -F "file=@document.pdf" \
  -F 'password=your-password' \
  -o result.pdf

JavaScript / TypeScript

// Node.js 20+ (TypeScript or JavaScript). Keep the key on your server.
import { openAsBlob } from "node:fs";
import { writeFile } from "node:fs/promises";

const form = new FormData();
form.append("file", await openAsBlob("document.pdf"), "document.pdf");
form.append("password", "your-password");

const response = await fetch("https://papydocs.vercel.app/api/v1/unlock", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PAPY_API_KEY}` },
  body: form,
});
if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`Papy API ${response.status}: ${error.code}`);
}
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));

Python

import os
import requests

response = requests.post(
    "https://papydocs.vercel.app/api/v1/unlock",
    headers={"Authorization": f"Bearer {os.environ['PAPY_API_KEY']}"},
    files=[
    ("file", ("document.pdf", open("document.pdf", "rb"), "application/pdf")),
    ],
    data={"password": "your-password"},
    timeout=120,
)
if not response.ok:
    raise RuntimeError(f"Papy API {response.status_code}: {response.json()['error']['code']}")
with open("result.pdf", "wb") as out:
    out.write(response.content)

Ba endpoints ya bobongisi ba fungola

Ezali kaka mpo na mokambi ya esika, oyo andimisamaka na jeton ya mokambi (kasi na fungola ya API te). Esalelamaka na eteni « Ba fungola mpe bosaleli » ya lokasa oyo.

GET/api/v1/keys— Lakisa ba fungola (kozanga ba sekele)
POST/api/v1/keys— Sala fungola (nzoto JSON na nkombo); sekele ezongaka mbala moko kaka
DELETE/api/v1/keys/{id}— Longola fungola
POST/api/v1/keys/{id}/rotate— Bongola fungola; sekele ya sika ezongaka mbala moko kaka
GET/api/v1/usage?days=30— Ba compteurs ya bosaleli mokolo na mokolo, na fungola mpe na mosala

Mabunga mpe ndelo

Mabunga esalelaka ba codes HTTP ya momesano mpe nzoto JSON elongo na code oyo ebongwanaka te mpe masini ekoki kotanga. Ba messages ebongolamaka na minoko te: salelá code na application na yo.

Lolenge ya mabunga

{
  "error": {
    "code": "authorization-required"
  }
}

Ezalela	Ndimbola	Ba codes ya mabunga
200	Elongi
400	Paramètre ezangi to ezali malamu te	invalid-options, empty-selection
401	Fungola ezangi, ezali malamu te to elongolami (to jeton ya mokambi)	authorization-required
404	Mosala to fungola eyebani te	invalid-options
413	Bosenga to mokanda eleki monene	request-too-large, file-too-large
415	Mokanda ezali PDF te	unsupported-type
422	PDF ekoki kosalema te (ebebi, ebombami na sekele, mot de passe ya mabe, makomi ezali te…)	corrupt, encrypted, wrong-password, no-text, invalid-range
429	Ndelo ya ngonga ekoki: zela ba secondes oyo elakisami na Retry-After	rate-limited
503	API, to bobongisi ba fungola, ezali kosala te na esika oyo	server-unavailable

Ndelo

Ndelo ya momesano: bosenga 120 na ngonga mpe na fungola (esika ekoki kobongola yango).
Eyano moko na moko ezali na X-RateLimit-Limit, X-RateLimit-Remaining mpe X-RateLimit-Reset (na ba secondes).
Tii 100 MB mpo na PDF moko, 200 MB mpo na bosenga moko mpe mikanda 60 mpo na bosenga moko.
Misala ya makomi etangaka tii nkasa 500 mpo na mokanda moko; boluki ezali na ndelo ya minkoko 200 mpe ba résultats 100.
Misala ya botaleli eboyaka mikanda ya scanner oyo ezali na makomi te (libunga no-text): salá OCR liboso, ndakisa na esaleli OCR ya PapyDocs.

Console ya komeka

Tinda bosenga ya solo na esika oyo na fungola na yo. Fungola etikalaka na mémoire ya lokasa oyo, etindamaka kaka na site oyo mpe ebombamaka soko moke te. Mikanda oyo oponi etindamaka na API kaka mpo na bosenga oyo.

Fungola ya API

Ebandaka na papy_. Ebombamaka te.

Mosala

file *

Ba fungola mpe bosaleli

Mpo na mokambi ya esika oyo. Koma jeton ya mokambi oyo ebongisami na serveur (elembo na yango etiamaka na PAPY_ADMIN_TOKEN_HASH). Jeton etikalaka kaka na mémoire ya lokasa oyo.

Bobateli ya ba données

Mikanda oyo etindami na API esalemaka na mémoire na tango ya bosenga mpe ebombamaka te.
PapyDocs ekomaka na ba journaux na yango te makomi ya mikanda, nkombo ya mikanda, ba paramètres to ba fungola.
Ba statistiques ya bosaleli ezali ba compteurs oyo ebombamaka mikolo 90.
Salelá kaka HTTPS. API esalelaka ba moteurs ya PapyDocs na serveur oyo; etindaka mikanda na yo epai ya mopesi IA te.

PapyDocs mpo na ba développeurs

Kobanda noki

Bondimisi (authentification)

Liste ya ba endpoints

Misala na mikanda

POST/api/v1/info— Bansango ya mokanda

POST/api/v1/merge— Kosangisa

POST/api/v1/split— Kokabola

POST/api/v1/compress— Kokomisa moke

POST/api/v1/rotate— Kobalusa

POST/api/v1/page-numbers— Mitango ya nkasa

POST/api/v1/watermark— Elembo ya mai (filigrane)

Mayele ya mikanda

POST/api/v1/text— Kobimisa makomi

POST/api/v1/search— Koluka na ba PDF mingi

POST/api/v1/invoice— Kobimisa ba données ya ba factures

POST/api/v1/contract— Kotalela kontra

POST/api/v1/compare— Kokanisa ba versions mibale

POST/api/v1/proofread— Kobongisa

Bokengi mpe sekele

POST/api/v1/remove-metadata— Kolongola ba métadonnées

POST/api/v1/protect— Kobatela na mot de passe

POST/api/v1/unlock— Kolongola mot de passe

Ba endpoints ya bobongisi ba fungola

Mabunga mpe ndelo

Ndelo

Console ya komeka

Ba fungola mpe bosaleli

Bobateli ya ba données

POST`/api/v1/info`— Bansango ya mokanda

POST`/api/v1/merge`— Kosangisa

POST`/api/v1/split`— Kokabola

POST`/api/v1/compress`— Kokomisa moke

POST`/api/v1/rotate`— Kobalusa

POST`/api/v1/page-numbers`— Mitango ya nkasa

POST`/api/v1/watermark`— Elembo ya mai (filigrane)

POST`/api/v1/text`— Kobimisa makomi

POST`/api/v1/search`— Koluka na ba PDF mingi

POST`/api/v1/invoice`— Kobimisa ba données ya ba factures

POST`/api/v1/contract`— Kotalela kontra

POST`/api/v1/compare`— Kokanisa ba versions mibale

POST`/api/v1/proofread`— Kobongisa

POST`/api/v1/remove-metadata`— Kolongola ba métadonnées

POST`/api/v1/protect`— Kobatela na mot de passe

POST`/api/v1/unlock`— Kolongola mot de passe