API

Pipelines (Rezepte)

Ein einzelner Job verkettet mehrere „tool_id“-Schritte in derselben temporären Serverdatei. Das Feld „tool_id“ in Ihrer Anfrage muss mit dem ersten Pipeline-Schritt übereinstimmen.

Webhooks: Erstellen Sie einen API-Schlüssel (POST /v1/api-keys mit Admin-Header), konfigurieren Sie PATCH /v1/api-keys/me/webhook und senden Sie dann Jobs mit der Autorisierung: Bearer sk_…. Signatur: X-PulsConv-Signature- und X-PulsConv-Timestamp-Header (HMAC-SHA256 des JSON-Körpers).

JSON-Beispiele (POST /v1/jobs)

PDF: Komprimieren und dann schützen

{
  "tool_id": "tool_pdf_compress",
  "upload_keys": ["uploads/xxx.pdf"],
  "options": { "quality": "ebook" },
  "pipeline": [
    { "tool_id": "tool_pdf_compress", "options": { "quality": "ebook" } },
    { "tool_id": "tool_pdf_protect", "options": { "password": "secret" } }
  ]
}

Bild: Größe ändern und dann weboptimieren

{
  "tool_id": "tool_image_resize",
  "upload_keys": ["uploads/photo.jpg"],
  "options": { "width": 1200, "height": 1200, "mode": "contain" },
  "pipeline": [
    { "tool_id": "tool_image_resize", "options": { "width": 1200, "height": 1200, "mode": "contain" } },
    { "tool_id": "tool_image_optimize_web", "options": { "max_width": 1200, "quality": 82 } }
  ]
}

cURL example (POST /api/v1/jobs)

curl -sS -X POST "$API/api/v1/jobs" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_id": "tool_pdf_compress",
    "upload_keys": ["uploads/mon.pdf"],
    "options": { "quality": "ebook" }
  }'

n8n — HTTP node

HTTP Request node → Method POST → URL {{$env.PULSCONV_API}}/api/v1/jobs
Body (JSON) : même objet que les exemples ci-dessus.
Réponse : { "id": "...", "status": "queued" }

For a webhook delivery log: keep traces on your endpoint (n8n, Zapier, your API); PulsConv can sign callbacks when you configure a secret.

Alle Werkzeuge Integrationskontakt