Which Sume Format for holiday product video? Read its io profile

Sume ships 27 ready-made Formats at the reserved sume handle, such as sume-product-commercial, sume-serum-drip, sume-slideshow and sume-video-hook. For a holiday catalog, pick by what each one declares, not by its name.

What to read

GET /v1/formats/sume/{slug} returns the Format's description and two fields: io and showcase.

• io.input_kind is url, text, image or product: it tells you the shape of input to send.
• io.output_kind is video, image or text.
• showcase is a worked example the Format really produced, checked against Sume's generated-media ledger.
• Both are null for Formats saved before registration. That means not declared, not takes no input.

Match it to your feed

If your feed has product page URLs, look for an input_kind of url. If it has packshots only, look for image. Then run one SKU before you queue 100, and compare the result against the showcase.

curl -sS "https://api.sume.com/v1/formats/sume/sume-product-commercial" \
  -H "Authorization: Bearer $SUME_API_KEY" | jq '(.data // .) | {description, io, showcase}'

A slug that is not in the list

Any slug outside the catalog answers 404 format_not_found at sume/{slug}. To change a catalog Format, fork it in the Format library; your copy is then called at {your_handle}/{slug}.