API

Pipelines (recipes)

A single job chains several tool_id steps on the same temporary server file. The tool_id field in your request must match the first pipeline step.

Webhooks: create an API key (POST /v1/api-keys with admin header), configure PATCH /v1/api-keys/me/webhook, then send jobs with Authorization: Bearer sk_…. Signature: X-PulsConv-Signature and X-PulsConv-Timestamp headers (HMAC-SHA256 of the JSON body).

JSON examples (POST /v1/jobs)

PDF: compress then protect

{
  "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" } }
  ]
}

Image: resize then web-optimize

{
  "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.

All tools Integration contact