Black Friday code freeze checklist for a Sume Format integration

Before the freeze: key scopes, spend caps, idempotency keys, a webhook test, queue failure handling and the rate-limit budget, all drawn from the Sume docs.

3 min readSume
All posts

A Black Friday freeze is a good moment to check eight things in your Sume Format integration. Every one is a documented behavior, and each is cheap to verify a week early.

The checklist

Pre-freeze checks (Sume docs, read 2026-10-05)
CheckWhat the docs say
Key scopesformats:write to create, formats:read to poll; a key without them gets 403 insufficient_scope, and scopes cannot be added to an old key
Key typeService-account keys cannot create runs or queues
Team FormatsA team-owned Format needs a key issued in that workspace
IdempotencyOne key per batch; a replay returns the old run or queue
Spend capsSet generation_spend_cap_usd per run; 0 is rejected, null means $500
Queue resultcompleted means all items are terminal; read counts.failed
WebhookSend a test delivery, verify the signature, ack fast
Rate limitWrites per minute: Free 120, Pro 300, Startup 600, Scale 1200; reads are 40 times that

Dry run

Submit a queue of two items at concurrency: 1 on a staging key, cancel one child with POST /v1/format-runs/{run_id}/cancel, and confirm your code handles completed with counts.canceled: 1 and no webhook for the canceled run.

  • 429: wait retry-after seconds; polling spends the read budget, not the write budget.
  • 503 studio_agent_upstream_unavailable during a poll is transient; the queue keeps running.

Freeze the payloads, not the schema

If you bind an output_schema, change nothing about it during the freeze: every property must be in required and every object needs additionalProperties: false, so a late edit is easy to get wrong.

Sources

Related posts

More in Developers

All Developers posts

Written by Sume