Skip to content
Log in
Developer API
Get your keyGet a key

Reference · Creative Board

POST/boards/{boardId}/cards/{cardId}/run

Run one card

Run one card on one of their Creative Boards — a picture, clip, voice, music, words or finish card — as its Run button does, with whatever is wired into it and the card’s own settings (GET /api/v1/boards/{boardId} shows them). A card already made runs again for another take. takes runs it more than once; each extra take lands on a copy of the card beneath it. Change a card’s words or settings first with PATCH /api/v1/boards/{boardId}/cards/{cardId}, and its wires with POST /api/v1/boards/{boardId}/wires; to run every card not made yet, in order, use POST /api/v1/boards/{boardId}/run. upgradeDraft makes the draft a clip card shows (Seedance 2.5, its draft setting on; GET /api/v1/boards/{boardId} says so) sharp instead: the same take at 1080p, priced at that rate for its length, within 7 days of the draft. It lands as the card’s take, the draft kept among its takes. It comes back as a job (kind "board-card") to follow with GET /api/v1/jobs/{jobId}.

Key needs
create · Make things and spend credits
Price it first
POST /boards/{boardId}/cards/{cardId}/run/quote · free
Answers
A job to follow
Request
curl -X POST https://vessero.com/api/v1/boards/0b6f3c1e-2d4a-4b5c-8d9e-0f1a2b3c4d5e/cards/9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d/run \
  -H "Authorization: Bearer $VESSERO_API_KEY" \
  -H "Idempotency-Key: 47f8f6f5-ea00-4fb1-925f-76aac956a0ec" \
  -H "Content-Type: application/json" \
  -d '{
    "confirmCredits": 1
  }'
Response202 Accepted
{
  "object": "job",
  "id": "board-card.8f1c2d3e-4b5a-4789-8abc-def012345678",
  "kind": "board-card",
  "status": "working",
  "stage": "Queued",
  "files": [],
  "credits": 58,
  "url": "/api/v1/jobs/board-card.8f1c2d3e-4b5a-4789-8abc-def012345678"
}
POST/boards/{boardId}/cards/{cardId}/run/quoteFree

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

Path

  • boardIdstringrequired—
  • cardIdstringrequired—

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

  • takesintegerHow many takes, 1–4, each priced as one. Default 1.
  • upgradeDraftbooleanTrue: make the draft the card shows sharp, rather than run the card again. Takes no takes.
  • 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}/cards/{cardId}/run/quote