Créer un PDF : génération synchrone par API

Générez un PDF à partir d’un template en un seul appel synchrone. La requête attend la fin du rendu, puis renvoie une URL signée ou directement les octets du PDF.

POST https://api.templatefox.com/v1/pdf/create

Authentification : clé API dans l’en-tête x-api-key. Crédits : 1 crédit par génération réussie (remboursé automatiquement si le rendu échoue).

Pour les gros documents, les traitements par lots ou les flux pilotés par webhook, l’endpoint create-pdf-async prend le relais.

Requête

Champs obligatoires

Seuls deux champs du corps de la requête sont obligatoires :

Champ	Type	Description
template_id	string	L’identifiant de 12 caractères de votre template (à copier depuis la liste des templates du tableau de bord).
data	object	Les paires clé-valeur à injecter dans le template. Les clés doivent correspondre aux variables {{variable}} de votre design.

curl TypeScript Python Go PHP Ruby Java C#

Copier

curl -X POST https://api.templatefox.com/v1/pdf/create \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "template_id": "HMQywVpZxqAM",
  "data": {
    "customer_name": "John Doe",
    "invoice_number": "INV-001",
    "amount": "$1,234.56"
  }
}'

const response = await fetch("https://api.templatefox.com/v1/pdf/create", {
method: "POST",
headers: {
  "x-api-key": "YOUR_API_KEY",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  template_id: "HMQywVpZxqAM",
  data: {
    customer_name: "John Doe",
    invoice_number: "INV-001",
    amount: "$1,234.56",
  },
}),
});

const { url } = await response.json();

import requests

response = requests.post(
  "https://api.templatefox.com/v1/pdf/create",
  headers={"x-api-key": "YOUR_API_KEY"},
  json={
      "template_id": "HMQywVpZxqAM",
      "data": {
          "customer_name": "John Doe",
          "invoice_number": "INV-001",
          "amount": "$1,234.56",
      },
  },
)

print(response.json()["url"])

package main

import (
  "bytes"
  "encoding/json"
  "fmt"
  "io"
  "net/http"
)

func main() {
  payload, _ := json.Marshal(map[string]any{
      "template_id": "HMQywVpZxqAM",
      "data": map[string]string{
          "customer_name":  "John Doe",
          "invoice_number": "INV-001",
          "amount":         "$1,234.56",
      },
  })

  req, _ := http.NewRequest("POST", "https://api.templatefox.com/v1/pdf/create", bytes.NewReader(payload))
  req.Header.Set("x-api-key", "YOUR_API_KEY")
  req.Header.Set("Content-Type", "application/json")

  resp, _ := http.DefaultClient.Do(req)
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println(string(body))
}

<?php
$ch = curl_init('https://api.templatefox.com/v1/pdf/create');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => [
      'x-api-key: YOUR_API_KEY',
      'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode([
      'template_id' => 'HMQywVpZxqAM',
      'data' => [
          'customer_name'  => 'John Doe',
          'invoice_number' => 'INV-001',
          'amount'         => '$1,234.56',
      ],
  ]),
]);

$response = json_decode(curl_exec($ch), true);
echo $response['url'];

require 'net/http'
require 'json'

uri = URI('https://api.templatefox.com/v1/pdf/create')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri, {
'x-api-key'    => 'YOUR_API_KEY',
'Content-Type' => 'application/json'
})
request.body = {
template_id: 'HMQywVpZxqAM',
data: {
  customer_name: 'John Doe',
  invoice_number: 'INV-001',
  amount: '$1,234.56'
}
}.to_json

response = JSON.parse(http.request(request).body)
puts response['url']

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();

var body = """
{
"template_id": "HMQywVpZxqAM",
"data": {
  "customer_name": "John Doe",
  "invoice_number": "INV-001",
  "amount": "$1,234.56"
}
}
""";

var request = HttpRequest.newBuilder()
  .uri(URI.create("https://api.templatefox.com/v1/pdf/create"))
  .header("x-api-key", "YOUR_API_KEY")
  .header("Content-Type", "application/json")
  .POST(HttpRequest.BodyPublishers.ofString(body))
  .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using System.Net.Http;
using System.Net.Http.Json;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var response = await client.PostAsJsonAsync(
  "https://api.templatefox.com/v1/pdf/create",
  new {
      template_id = "HMQywVpZxqAM",
      data = new {
          customer_name = "John Doe",
          invoice_number = "INV-001",
          amount = "$1,234.56"
      }
  }
);

Console.WriteLine(await response.Content.ReadAsStringAsync());

Ou passez par l’un de nos SDK officiels : TypeScript, Python, Go, PHP, Ruby, Java, C#.

Tous les paramètres

Champ	Type	Obligatoire	Défaut	Description
template_id	string	✅	—	Identifiant court du template, 12 caractères.
data	object	✅	—	Les données clé-valeur injectées dans le template. Voir Liaison de données.
export_type	string	—	"url"	"url" dépose le PDF sur notre CDN et renvoie une URL signée. "binary" renvoie directement les octets du PDF, en application/pdf.
expiration	integer	—	86400	Durée de validité de l’URL, en secondes. Minimum 60, maximum 604800 (7 jours). S’applique uniquement avec export_type="url".
filename	string	—	"document"	Nom de fichier personnalisé (sans l’extension .pdf). Lettres, chiffres, _, - et . uniquement. 100 caractères maximum.
store_s3	boolean	—	false	Envoie le fichier dans votre bucket S3 configuré plutôt que sur notre CDN. Nécessite une intégration S3.
s3_filepath	string	—	—	Préfixe de chemin dans votre bucket S3. Remplace default_prefix. 500 caractères maximum.
s3_bucket	string	—	—	Remplace le nom de bucket de votre intégration S3 (3 à 63 caractères, en minuscules).
pdf_variant	string	—	—	Génère un PDF conforme à une norme. Valeurs : "pdf/a-1b", "pdf/a-2b", "pdf/a-3b". Voir Normes PDF.
version	string	—	—	Tag de version du template (par exemple "prod") ou numéro de version (par exemple "3"). Sans version, le brouillon en cours est utilisé. 50 caractères maximum.

Réponse

export_type = "url" (par défaut)

Renvoie un objet JSON avec une URL signée vers le PDF généré.

{
  "url": "https://cdn.templatefox.com/generated/abc123/invoice.pdf",
  "filename": "invoice-001.pdf",
  "credits_remaining": 99,
  "expires_in": 86400
}

Champ	Type	Description
url	string	URL signée pour télécharger le PDF (expire au bout de expires_in secondes).
filename	string	Nom de fichier final du PDF généré.
credits_remaining	number	Crédits restants sur le solde de votre équipe après cet appel.
expires_in	number	Nombre de secondes avant l’expiration de l’URL signée.

export_type = "binary"

Renvoie le fichier PDF brut, en application/pdf. Pratique pour transmettre le fichier directement à un utilisateur ou le stocker vous-même. expiration, filename et les options S3 sont ignorés.

En-têtes de la réponse :

Content-Type: application/pdf
Content-Disposition: attachment; filename="HMQywVpZxqAM.pdf"
X-Credits-Remaining: 99

store_s3 = true

Quand l’envoi vers S3 est demandé, la réponse indique où le fichier a été déposé dans votre bucket, au lieu de renvoyer une URL :

{
  "s3_bucket": "my-pdf-bucket",
  "s3_key": "invoices/2026/01/invoice-001.pdf",
  "filename": "invoice-001.pdf",
  "credits_remaining": 99
}

Exemple :

curl TypeScript Python Go

Copier

curl -X POST https://api.templatefox.com/v1/pdf/create \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "template_id": "HMQywVpZxqAM",
  "data": { "customer_name": "John Doe" },
  "store_s3": true,
  "filename": "invoice-001",
  "s3_filepath": "2026/01/"
}'

const response = await fetch("https://api.templatefox.com/v1/pdf/create", {
method: "POST",
headers: {
  "x-api-key": "YOUR_API_KEY",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  template_id: "HMQywVpZxqAM",
  data: { customer_name: "John Doe" },
  store_s3: true,
  filename: "invoice-001",
  s3_filepath: "2026/01/",
}),
});

const { s3_bucket, s3_key } = await response.json();

import requests

response = requests.post(
  "https://api.templatefox.com/v1/pdf/create",
  headers={"x-api-key": "YOUR_API_KEY"},
  json={
      "template_id": "HMQywVpZxqAM",
      "data": {"customer_name": "John Doe"},
      "store_s3": True,
      "filename": "invoice-001",
      "s3_filepath": "2026/01/",
  },
)

result = response.json()
print(result["s3_bucket"], result["s3_key"])

payload, _ := json.Marshal(map[string]any{
  "template_id":  "HMQywVpZxqAM",
  "data":         map[string]string{"customer_name": "John Doe"},
  "store_s3":     true,
  "filename":     "invoice-001",
  "s3_filepath":  "2026/01/",
})

req, _ := http.NewRequest("POST", "https://api.templatefox.com/v1/pdf/create", bytes.NewReader(payload))
req.Header.Set("x-api-key", "YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PDF/A (archivage)

Renseignez pdf_variant pour produire un PDF qui passe les contrôles de conformité PDF/A : facturation électronique (Factur-X, ZUGFeRD), archivage, secteurs réglementés.

curl TypeScript Python Go

Copier

curl -X POST https://api.templatefox.com/v1/pdf/create \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "template_id": "HMQywVpZxqAM",
  "data": { "customer_name": "John Doe" },
  "pdf_variant": "pdf/a-3b"
}'

const response = await fetch("https://api.templatefox.com/v1/pdf/create", {
method: "POST",
headers: {
  "x-api-key": "YOUR_API_KEY",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  template_id: "HMQywVpZxqAM",
  data: { customer_name: "John Doe" },
  pdf_variant: "pdf/a-3b",
}),
});

const { url } = await response.json();

import requests

response = requests.post(
  "https://api.templatefox.com/v1/pdf/create",
  headers={"x-api-key": "YOUR_API_KEY"},
  json={
      "template_id": "HMQywVpZxqAM",
      "data": {"customer_name": "John Doe"},
      "pdf_variant": "pdf/a-3b",
  },
)

print(response.json()["url"])

payload, _ := json.Marshal(map[string]any{
  "template_id": "HMQywVpZxqAM",
  "data":        map[string]string{"customer_name": "John Doe"},
  "pdf_variant": "pdf/a-3b",
})

req, _ := http.NewRequest("POST", "https://api.templatefox.com/v1/pdf/create", bytes.NewReader(payload))
req.Header.Set("x-api-key", "YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Réponse binaire

Avec export_type à "binary", vous recevez directement les octets du PDF : pratique pour les transmettre à l’utilisateur ou les enregistrer sur disque, sans passer par le CDN.

curl TypeScript Python Go

Copier

curl -X POST https://api.templatefox.com/v1/pdf/create \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
--output invoice.pdf \
-d '{
  "template_id": "HMQywVpZxqAM",
  "data": { "customer_name": "John Doe" },
  "export_type": "binary"
}'

import fs from "node:fs";

const response = await fetch("https://api.templatefox.com/v1/pdf/create", {
method: "POST",
headers: {
  "x-api-key": "YOUR_API_KEY",
  "Content-Type": "application/json",
},
body: JSON.stringify({
  template_id: "HMQywVpZxqAM",
  data: { customer_name: "John Doe" },
  export_type: "binary",
}),
});

const buffer = Buffer.from(await response.arrayBuffer());
fs.writeFileSync("invoice.pdf", buffer);

import requests

response = requests.post(
  "https://api.templatefox.com/v1/pdf/create",
  headers={"x-api-key": "YOUR_API_KEY"},
  json={
      "template_id": "HMQywVpZxqAM",
      "data": {"customer_name": "John Doe"},
      "export_type": "binary",
  },
)

with open("invoice.pdf", "wb") as f:
  f.write(response.content)

payload, _ := json.Marshal(map[string]any{
  "template_id": "HMQywVpZxqAM",
  "data":        map[string]string{"customer_name": "John Doe"},
  "export_type": "binary",
})

req, _ := http.NewRequest("POST", "https://api.templatefox.com/v1/pdf/create", bytes.NewReader(payload))
req.Header.Set("x-api-key", "YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

out, _ := os.Create("invoice.pdf")
defer out.Close()
io.Copy(out, resp.Body)

Erreurs

Statut	Quand
400	Le template est un template image : utilisez create-image.
401	Clé API absente ou invalide.
402	Le solde de crédits de votre équipe est à 0.
403	Le template n’existe pas ou n’appartient pas à votre équipe.
404	La version demandée n’existe pas.
422	Un paramètre est manquant ou invalide.
429	Limite de requêtes atteinte (voir les en-têtes de la réponse).
500	Erreur serveur. Si le rendu lui-même échoue, le crédit est remboursé automatiquement.

La liste complète est dans la vue d’ensemble de la référence API.