应用程序编程接口
管道(配方)
单个作业将多个 tool_id 步骤链接到同一个临时服务器文件上。 您请求中的 tool_id 字段必须与第一个管道步骤匹配。
Webhooks:创建 API 密钥(带有管理标头的 POST /v1/api-keys),配置 PATCH /v1/api-keys/me/webhook,然后使用授权发送作业:Bearer sk_…。 签名:X-PulsConv-Signature 和 X-PulsConv-Timestamp 标头(JSON 主体的 HMAC-SHA256)。
JSON 示例 (POST /v1/jobs)
PDF:压缩然后保护
{
"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" } }
]
}图像:调整大小然后进行网页优化
{
"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.
