API Documents

Générez des documents en envoyant une définition de document JSON à l'API.

Spécifications lisibles par machine :

• Spécification OpenAPI (JSON) — importez dans Postman, Insomnia ou votre passerelle API
• Schéma JSON de définition de document — pour l'autocomplétion IDE et la validation de charge utile

POST /documents/generate-from-payload/{format}

Générez un document à partir d'une définition de document envoyée en tant que corps de requête JSON. Ajoutez le format de sortie souhaité au chemin du point de terminaison.

Point de terminaison

POST /api/v1/{'tenantId'}/documents/generate-from-payload/{format}

format	Sortie
pdf	Document PDF (par défaut)
docx	Document Word
svg	Image SVG (première page)

En-têtes

En-tête	Valeur	Requis
Authorization	Bearer YOUR_API_KEY	Oui
Content-Type	application/json	Oui

Paramètres de chemin

Paramètre	Type	Description
tenantId	string	Votre identifiant de locataire

Corps de la requête

Le corps de la requête est une définition de document JSON. Voir Définition de document pour le schéma complet.

{
  "document": {
    "metadata": {
      "title": "Shipment Confirmation",
      "author": "ShipForge"
    },
    "pageSetup": {
      "size": "A4",
      "orientation": "portrait",
      "margins": [50, 40, 50, 40]
    },
    "styles": {
      "title": { "fontSize": 22, "fontWeight": "bold", "color": "#1A1A2E" },
      "body": { "fontSize": 10, "color": "#333333" }
    },
    "content": [
      { "p": "Shipment Confirmation", "style": "title" },
      { "p": "Your package has been dispatched and is on its way.", "style": "body" }
    ]
  }
}

Réponse

Succès (200 OK)

Retourne un objet JSON avec les métadonnées du document généré et une URL de téléchargement.

{
  "fileName": "doc-20260330-143022-abc123.pdf",
  "documentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "Completed",
  "fileSizeBytes": 24576,
  "contentType": "application/pdf",
  "downloadUrl": "https://api.docpayload.com/v1/{'tenantId'}/assets/docs/doc-20260330-143022-abc123.pdf"
}

Les champs fileName et contentType reflètent le format demandé (par exemple .docx / application/vnd.openxmlformats-officedocument.wordprocessingml.document pour DOCX).

Erreur (400 Bad Request)

{
  "message": "The document definition must have valid content."
}

Exemple

curl -X POST https://api.docpayload.com/v1/{'tenantId'}/documents/generate-from-payload/pdf \
  -H "Authorization: Bearer dp_live_abc123def456" \
  -H "Content-Type: application/json" \
  -d '{
    "document": {
      "content": [
        { "p": "Hello from DocPayload!" }
      ]
    }
  }'

---

GET /documents

Listez tous les documents générés pour le locataire.

Point de terminaison

GET /api/v1/{'tenantId'}/documents

En-têtes

En-tête	Valeur	Requis
Authorization	Bearer YOUR_API_KEY	Oui

Réponse

Succès (200 OK)

Retourne un tableau d'objets de métadonnées de document.

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "fileName": "doc-20260330-143022-abc123.pdf",
    "documentId": "d4e5f6a7-b8c9-0123-4567-89abcdef0123",
    "createdAt": "2026-03-30T14:30:22Z",
    "fileSizeBytes": 24576,
    "contentType": "application/pdf",
    "expiresAt": "2026-04-29T14:30:22Z",
    "downloadUrl": "https://api.docpayload.com/v1/{'tenantId'}/assets/docs/doc-20260330-143022-abc123.pdf"
  }
]

---

GET /documents/{fileName}

Téléchargez un document précédemment généré par nom de fichier.

Point de terminaison

GET /api/v1/{'tenantId'}/documents/{fileName}

En-têtes

En-tête	Valeur	Requis
Authorization	Bearer YOUR_API_KEY	Oui

Paramètres de chemin

Paramètre	Type	Description
tenantId	string	Votre identifiant de locataire
fileName	string	Le nom du fichier retourné de la génération

Réponse

Succès (200 OK)

Retourne le fichier de document en tant que contenu binaire avec le type de contenu correspondant au format (application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document ou image/svg+xml).

Erreur (404 Not Found)

{
  "message": "Document not found."
}

Exemple

curl -X GET https://api.docpayload.com/v1/{'tenantId'}/documents/doc-20260330-143022-abc123.pdf \
  -H "Authorization: Bearer dp_live_abc123def456" \
  -o downloaded.pdf