Which ready-made Sume Formats can I call today? 27 slugs
Sume's first-party Format catalog answers at the sume handle with 27 slugs, from UGC and product demos to try-on, product splashes and recreate. List and call.
Twenty-seven ready-made Formats answer at the reserved sume handle today, and any API key with formats:write can call one with POST /v1/formats/sume/{slug}/runs (Format catalog). The run, its media and its spend belong to the key that made the call, and you do not fork or copy anything first.
The grouping below is by name only. Read each Format's description and io profile before you rely on it.
The 27 slugs, grouped by name
| Group | Slugs | Count |
|---|---|---|
| UGC, demos and short-form | sume-close-camera-ugc, sume-mobile-app-ugc, sume-product-usage-demo, sume-video-hook, sume-wall-of-text, sume-green-screen, sume-slideshow, sume-fruits-drama | 8 |
| Product and commercial heroes | sume-product-commercial, sume-cinematic-studio-commercial, sume-water-splash-hero, sume-formula-texture-hero, sume-sunscreen-splash, sume-cream-squeeze, sume-serum-drip, sume-toner-pour, sume-editorial-product-set, sume-logo-motion-design | 10 |
| People, fashion and beauty | sume-virtual-try-on, sume-virtual-fitting, sume-fashion-editorial, sume-beauty-studio, sume-model-product-portrait, sume-magazine-cover-campaign, sume-before-after | 7 |
| Remake an existing piece | sume-recreate, sume-restyle | 2 |
Read before you call
GET /v1/formats/sume/{slug} returns the description and the io profile. Any slug not on this list answers 404 format_not_found.
curl -sS "https://api.sume.com/v1/formats/sume/sume-video-hook" \
-H "Authorization: Bearer $SUME_API_KEY"What `io` tells you
input_kind is url, text, image or product, and output_kind is video, image or text. It is null on Formats saved before the field existed, which means not declared, not takes no input.
To change a catalog Format, fork it in the Format library; your copy then lives at {your_handle}/{slug} and you call it the same way.
What a call looks like
The run body puts your data in input, and production callers also send generation_spend_cap_usd and, optionally, an output_schema and a communication.webhook_url. A fresh run returns 202 with a receipt carrying status_url, result_url and cancel_url. Repeating the same Idempotency-Key with the same body returns 200 with the original run and idempotency_hit: true.
Calling a catalog Format uses the same wire contract as calling a Format you wrote yourself; the only difference is the sume handle in the path.
Sources
Related posts
More in Formats
- Which Sume Format for a UGC ad? Read io, then call by name
Sume's catalog lists UGC-style Formats such as sume-close-camera-ugc and sume-mobile-app-ugc. Read each Format's io profile, then run it with a spend cap.
- Which Sume Formats return images, not video? 9 of the 27 slugs
Of the 27 Formats by Sume, 18 declare video output and 9 declare image output. The slug lists, how to read the io profile, and why to check before you call.
- Bulk queue item with run_id null and format_run_failed_to_start
In a Sume Format bulk queue, an item that never started has run_id null and an error like format_run_failed_to_start. The queue goes on; resubmit that row.
- Course intro video output_schema: optional fields must be nullable
Bind a strict output_schema to a course-intro Format run so the intro and title card come back as typed fields. Optional keys must allow null.
Written by Sume