Formats

Ready-made Formats for product video: the Sume Format catalog

Sume ships ready-made Formats for product and UGC-style video and images, each callable from your backend with one HTTP request at the reserved sume handle.

4 min readSume
All posts

Sume ships a catalog of ready-made Formats for product video and product imagery. There are 27 today. Each one answers at the reserved sume handle, so a production workflow can be one HTTP call instead of a prompt you maintain: POST /v1/formats/sume/{slug}/runs.

If Formats are new to you, start with What is a Sume Format?. The details below come from the Format catalog docs.

Which Formats are in the catalog?

Read any one before calling it with GET /v1/formats/sume/{slug}, which returns its description and its declared IO profile. Any slug not in the catalog answers 404 format_not_found.

The published first-party catalog. “Example output” is what the Format's curated example produces.
SlugNameExample output
sume-close-camera-ugcSume Close Camera UgcVideo
sume-virtual-try-onSume Virtual Try OnVideo
sume-product-usage-demoSume Product Usage DemoVideo
sume-mobile-app-ugcSume Mobile App UgcVideo
sume-before-afterSume Before AfterVideo
sume-product-commercialSume Product CommercialVideo
sume-beauty-studioSume Beauty StudioVideo
sume-logo-motion-designSume Logo Motion DesignVideo
sume-cinematic-studio-commercialSume Cinematic Studio CommercialVideo
sume-fashion-editorialSume Fashion EditorialVideo
sume-virtual-fittingSume Virtual FittingVideo
sume-water-splash-heroSume Water Splash HeroImage
sume-model-product-portraitSume Model Product PortraitImage
sume-magazine-cover-campaignSume Magazine Cover CampaignImage
sume-formula-texture-heroSume Formula Texture HeroImage
sume-sunscreen-splashSume Sunscreen SplashImage
sume-cream-squeezeSume Cream SqueezeImage
sume-serum-dripSume Serum DripImage
sume-toner-pourSume Toner PourImage
sume-editorial-product-setSume Editorial Product SetImage
sume-slideshowSume SlideshowVideo
sume-wall-of-textSume Wall Of TextVideo
sume-green-screenSume Green ScreenVideo
sume-video-hookSume Video HookVideo
sume-fruits-dramaSume Fruits DramaVideo
sume-recreateSume RecreateVideo
sume-restyleSume RestyleVideo

How do I pick a Format without calling it?

GET /v1/formats and GET /v1/formats/{format_id} return an io profile for each Format. input_kind is one of url, text, image, or product, and output_kind is one of video, image, or text. Use it to filter a list before you call anything. Formats registered with a showcase also carry a worked example the Format actually produced, verified against Sume's generated-media ledger.

Both fields can be null for Formats saved before registration existed. That means “not declared”, not “takes no input”; fall back to the Format's description.

How do I call one?

Any API key with formats:write can call a catalog Format. The run, its media, and its spend belong to your key's workspace; the catalog Format itself stays shared, so there is nothing to fork or install first.

curl -sS -X POST "https://api.sume.com/v1/formats/sume/sume-product-commercial/runs" \
  -H "Authorization: Bearer $SUME_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: sku-4411-commercial-v1" \
  -d '{
    "instruction": "15-second 9:16 commercial for the attached product.",
    "attachments": [
      { "type": "input_image", "image_url": "https://cdn.example.com/sku-4411.jpg" }
    ],
    "generation_spend_cap_usd": 20
  }'

Can I change a catalog Format?

Yes. Fork it in the Format library. Your copy is addressed as {your_handle}/{slug} and is called exactly the same way as the original.

How do I put this in my own product?

Your server holds one Sume API key and runs Formats on your customer's behalf; your customer never talks to Sume. The Embed a Format cookbook covers key custody, idempotency, webhooks, spend caps, and failures. With `@sume-com/sdk`, subscribeFormatRun creates a run and waits for the terminal receipt in one call; in production, prefer a webhook.

Sources

Related posts

Written by Sume