Prefect Pony XL API

HTTP/1.1 202 Accepted
Location: /api/v1/jobs/recordInfo?taskId=job_01k3m8x9q2z4v7n5p6r8s0t1w3

{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_create",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "state": "queued",
    "estimatedCost": "0.750000"
  }
}

La réponse d’acceptation inclut l’estimation afin que votre application affiche le même montant dans l’historique des tâches et la facturation.

curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
  --data-urlencode "taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Commencez vers 2 secondes d’intervalle, puis espacez progressivement. Arrêtez-vous sur un état final. Après une coupure réseau, interrogez le taskId d’origine. Ne relancez la création qu’avec la clé d’idempotence et le corps d’origine.

import { verifyWebhook } from "@spicyapi/sdk";

// express.raw keeps the bytes we signed; express.json never matches.
app.post("/hooks/spicy", express.raw({ type: "application/json" }), (req, res) => {
  const { payload } = verifyWebhook({
    rawBody: req.body,
    timestamp: req.header("X-Webhook-Timestamp"),
    signature: req.header("X-Webhook-Signature"),
    payloadVersion: Number(req.header("X-Webhook-Payload-Version")),
    secret: process.env.SPICY_WEBHOOK_SECRET,
  });
  res.status(200).end();
  void handleFinishedTask(payload);
});

Passez callBackUrl à la création de la tâche et l’enregistrement terminé vous est envoyé en POST — plus de boucle d’interrogation du tout. Chaque livraison porte X-Webhook-Timestamp, X-Webhook-Signature et X-Webhook-Payload-Version. La signature est un HMAC-SHA256 en base64 sur taskId.timestamp.sha256(body) : vérifiez-la donc sur les octets bruts, car analyser le JSON puis le re-sérialiser les modifie et le contrôle échouera. Les livraisons en échec sont réessayées, le même taskId peut donc arriver deux fois — rendez le gestionnaire idempotent. Répondez 2xx d’abord, traitez ensuite : un gestionnaire lent est compté comme une livraison ratée.