Run every card of a board, or the ones named

Run one of their boards, as its Run all does: every card not made yet — or the cards in cardIds, with what they read from — in the order the wires put them in, so a picture is made before the clip that opens on it. Each card is charged as it starts, and one that fails gives its credits back. The quote names each card with its price; a total marked "about" reads what the run makes first, and is held to the most it can cost. It comes back as a job (kind "board-run") to follow with GET /api/v1/jobs/{jobId}.

Key needs: create · Make things and spend credits
Price it first: POST /boards/{boardId}/run/quote · free
Answers: A job to follow

Request

curl -X POST https://vessero.com/api/v1/boards/0b6f3c1e-2d4a-4b5c-8d9e-0f1a2b3c4d5e/run \
  -H "Authorization: Bearer $VESSERO_API_KEY" \
  -H "Idempotency-Key: 47f8f6f5-ea00-4fb1-925f-76aac956a0ec" \
  -H "Content-Type: application/json" \
  -d '{
    "confirmCredits": 240,
    "webhookUrl": "https://example.com/hooks/vessero"
  }'

Response202 Accepted

{
  "object": "job",
  "id": "board-run.8f1c2d3e-4b5a-4789-8abc-def012345678",
  "kind": "board-run",
  "status": "working",
  "stage": "Queued",
  "files": [],
  "credits": 58,
  "url": "/api/v1/jobs/board-run.8f1c2d3e-4b5a-4789-8abc-def012345678"
}

POST/boards/{boardId}/run/quoteFree

The same body without confirmCredits. It answers the price and your balance, and runs nothing.

Path

boardIdstringrequired—

Header

Idempotency-KeystringYour id for this request: 8–64 letters, digits, - or _. A repeat within 10 minutes gets the first answer back and never runs twice. Use the same one for the quote and the run.
Preferstringwait=N (up to 60): hold the answer up to N seconds while the job is made, within 80 seconds for the whole call.

Body

cardIdsstring[] · up to 200Only these cards, with the cards they read from; left out, every card not made yet.
confirmCreditsintegerrequiredThe price you agree to, in credits: the credits its quote gave. It runs at that price, or at a lower one when that figure was quoted for this Idempotency-Key; above the price now, nothing runs (409 price_changed). Left out, nothing runs and the error carries the quote.
webhookUrlstring · httpsAn https address to POST the job to once it is done or has failed, signed (see Webhooks).

Answers

202jobStarted: follow the job, or wait for its webhook.
200jobA job that ended at once: done, or failed (see error and charged).
400confirm_credits_requiredA run that spends needs confirmCredits: the quote is in details.
402insufficient_creditsThe account has too few credits for this.
409price_changedThe price is above the confirmCredits sent: nothing ran; the new quote is in details.
422content_refusedThe content check refused it.
429daily_cap_reachedThe key’s daily credit cap would be passed: see Retry-After.

Next in Creative BoardPOST/boards/{boardId}/run/quotePrice it: run every card of a board, or the ones named