API-Überblick
Basis-URL, Authentifizierung, Konventionen für Anfragen und Antworten, Header, Paginierung, Idempotenz, Wiederholungen, Versionierung und eine Übersicht aller Endpunkte.
Authentifizierung
API-Schlüssel, Test- und Live-Umgebung, Scopes, Umgang mit Schlüsseln und Rotation, Sitzungstokens der App und von KI-Agenten, und wie sich die CLI anmeldet.
Rendering
POST /v1/renders im Detail: die Felder der Anfrage, die drei Quellen, Ausgabeformate, Einstellungen pro Anfrage, Datenprüfung, Dateinamen, Download-Links und Aufbewahrung, synchron und asynchron, Zeitlimits, Post-Processing, Deduplizierung und Reproduzierbarkeit.
Asynchron und Batch
Lange Renderings einreihen, bis zu 1.000 Dokumente in einem Job verarbeiten, ein Zip erhalten und Ergebnisse über Webhooks oder Abfragen erfahren.
PDF-Tools
PDFs zusammenführen, mit Passwort schützen, mit Wasserzeichen versehen und untersuchen und Office-Dokumente in PDF umwandeln: der post-Block eines Renderings und die /pdf-Endpunkte, Kosten, Reihenfolge der Schritte und Fehler.
Dateien
Laden Sie Bilder und PDFs für Ihre Vorlagen in die Dateibibliothek des Workspace, binden Sie sie über ihren Namen mit asset() ein und nutzen Sie sie als Wasserzeichen und Merge-Quellen.
Brand Kit und Partials
Das Brand Kit der Organisation mit GET /brand lesen und geteilte Partials über die Partials-Endpunkte verwalten, samt Konflikterkennung mit base_version.
Webhooks
Ereignisse, Nutzlasten, Prüfung der Signatur in Node, Python und jeder anderen Sprache, Wiederholungen und wie Sie einen zuverlässigen Handler bauen.
Webhooks lokal entwickeln
Leiten Sie die Webhook-Ereignisse Ihres Workspace mit formfeed listen an einen Server auf Ihrem Rechner weiter, prüfen Sie sie mit dem Sitzungsgeheimnis, senden Sie Ereignisse erneut und lösen Sie echte aus.
Eigener Speicher
Jedes Dokument in Ihren eigenen Bucket bei Amazon S3, Cloudflare R2 oder einem S3-kompatiblen Dienst kopieren: Bucket verbinden, minimale Berechtigungen je Anbieter, Objektschlüssel, die Option storage einer Anfrage, Wiederholungen und Pausieren, erneute Zustellung, die Speicher-Ereignisse und das Feld storage.
Vorlagen-API
Vorlagen anlegen, Versionen hinzufügen und veröffentlichen, Konflikte mit base_checksum erkennen, Datenschemas vor dem Veröffentlichen prüfen, Release Channels verwalten und Datenschemas aus Code lesen.
Limits und Verbrauch
Rate-Limits, Parallelität, Seiten-, Größen- und Aufbewahrungslimits pro Plan, wie Einheiten gezählt werden, Abrechnungsperioden, Kontingent und Ausgabenlimit, und wie Sie den Verbrauch über die API lesen.
Fehler
46 Einträge
Datenresidenz
Wo Formfeed Ihre Daten verarbeitet und speichert, was die EU verlässt, wie lange es aufbewahrt wird, und wie es dabei bleibt.
apitemplate.io-Kompatibilitätsendpunkte
Die bestehende apitemplate.io-Integration während der Migration weiterlaufen lassen; vier Endpunkte mit ihren Anfrage- und Antwortformaten.
SDKs
2 Einträge
Referenz
11 Einträge