Skip to main content
POST
Generate a GIF

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100
X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json

A from discriminator: { from:"prompt", prompt, … }, { from:"image", imageUrl, … }, or { from:"video", videoUrl, … }.

from
enum<string>
required
Available options:
prompt
prompt
string
required

What the GIF shows and how it moves.

Required string length: 1 - 2000
frameCount
integer

Frames in the loop, 2–16 (default 9).

Required range: 2 <= x <= 16
fps
integer

Frames per second, 1–24 (default 5 for generated GIFs).

Required range: 1 <= x <= 24
aspectRatio
enum<string>

The GIF's shape (default 16:9): 768×432, 432×768 or 640×640.

Available options:
16:9,
9:16,
1:1
loop
boolean

Repeat forever (default true); false plays once.

Response

The operation result.

gifUrl
string<uri>
required
altText
string
duration
number
fps
number
frameCount
integer
aspectRatio
string
width
integer
height
integer
loop
boolean