---
title: Recipes
description: Short current-platform recipes for common Sume API workflows.
---

This page is a compact recipe index. Prefer canonical `/v1/avatar-1.0/*` routes
for Avatar. Deep guides live under [Models](/models).

Running a Format on behalf of your own customers is a longer recipe of its own —
see [Embed a Format in your product](/cookbooks/embed-a-format).

## Verify a key

```bash
curl https://api.sume.com/v1/me \
  -H "Authorization: Bearer $SUME_API_KEY"
```

## List current capabilities

```bash
curl https://api.sume.com/v1/catalog \
  -H "Authorization: Bearer $SUME_API_KEY"
```

## Create an avatar

<!-- api-call-example:avatar-generate -->

## Create an avatar video

Avatar-video scripts must estimate to 4-60 seconds inclusive. Omit `quality`
for the default **`plus`** path.

<!-- api-call-example:avatar-talking-video -->

## Preview first frames, then generate

<!-- api-call-example:avatar-video-preview-create -->

After the preview job completes:

<!-- api-call-example:avatar-video-preview-generate -->

## Face swap (Beta)

<!-- api-call-example:face-swap-run -->

## Caption an existing video

<!-- api-call-example:video-caption-create -->

## Search trending TikTok videos

<!-- api-call-example:trending-videos-search -->

## Generate an image

Deep guide: [Image 1.0](/models/image).

<!-- api-call-example:image-generate -->

## Generate a video

Deep guide: [Video 1.0](/models/video).

<!-- api-call-example:video-generate -->

## Generate music

Deep guide: [Music 1.0](/models/music). Do not send `duration` on Music 1.0.

<!-- api-call-example:music-generate -->

## Poll and fetch result

```bash
curl https://api.sume.com/v1/jobs/job_123/status \
  -H "Authorization: Bearer $SUME_API_KEY"

curl https://api.sume.com/v1/jobs/job_123/result \
  -H "Authorization: Bearer $SUME_API_KEY"
```

## Use media inputs

Use public HTTPS URLs directly in launch request fields (URL-first; no separate
asset upload required for normal flows):

- Avatar photo input: `input.image_url`
- Avatar Video product reference: `product_image`
- Avatar Video scene photo reference: `scene.image_url`
- Face swap / captions source: `video_url`

See [Media inputs](/workflows/asset-library).

## Read usage

```bash
curl https://api.sume.com/v1/balance \
  -H "Authorization: Bearer $SUME_API_KEY"

curl https://api.sume.com/v1/usage \
  -H "Authorization: Bearer $SUME_API_KEY"
```