Skip to main content
POST
Berry
Mage’s reference-driven video model; Berry 2 is the current version. A first frame or reference images, or a source video to edit.

Options by model

The tokens each variant accepts. A field left out inherits the architecture default, clamped to the variant’s first listed token when the variant does not offer it.

Rules

A request that breaks one of these is refused with 400 invalid_config before any gems are charged.
  • A first frame cannot be combined with reference images.
  • A source video must be between 3 and 60 seconds.
Every field below that you leave out keeps its default. Option values are the raw tokens listed per field; a numeric token may be sent as a number. Fields the schema does not list pass through to the model unchanged. The exact charge for other settings is in the response’s billing.gems_charged, and the balance at GET /v1/account.

Authorizations

Authorization
string
header
required

An API key from Settings → API, sent as Authorization: Bearer mage_sk_…. Keys are for server-side code only.

Headers

Idempotency-Key
string

A key of your choosing, 1 to 255 characters, scoped to your API key. A retried submit with the same key returns the original request with 200 instead of charging again. The key identifies the first submission made with it; later bodies are not compared. A refusal recorded under the key (its envelope carries request_id) replays the same way, so a new attempt needs a new key.

Required string length: 1 - 255

Body

application/json

A partial config for Berry.

prompt
string
required

The text prompt.

Minimum string length: 1
seed
integer | null

Integer seed for reproducible output; omit or send null for a random seed.

model_id
enum<string>
default:berry-2

The model variant to generate with.

Available options:
berry,
berry-2
berry_aspect_ratio
enum<string>
default:16:9

Aspect ratio token.

Available options:
16:9,
9:16,
1:1,
4:3,
3:4,
4:5,
5:4
resolution
enum<string>
default:480p

Output resolution token.

Available options:
720p,
1080p,
480p
duration
enum<string>
default:3

Clip length in seconds, as a token.

Available options:
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
first_image

The first frame image. An https URL or a data URL.

image

The reference image. An https URL or a data URL.

additional_images
(string<uri> | string)[]

Additional reference images. Each an https URL or a data URL.

video

The source video. An https URL or a data URL.

Response

The request was accepted; poll status_url for the result. A retried submit whose Idempotency-Key was used before answers 200 with the same shape, the original request, and charges nothing.

request_id
string<uuid>
required

The request id, also the id in status_url and cancel_url.

status
enum<string>
required

queued and in_progress are live; completed, failed, and cancelled are final.

Available options:
queued,
in_progress,
completed,
failed,
cancelled
architecture
string
required

The architecture the request generates with.

model_id
string | null
required

The model variant, when the architecture has variants.

created_at
string<date-time>
required

When the request was accepted.

updated_at
string<date-time>
required

When the request last changed.

billing
object
required
result
object | null
required

The output once status is completed, else null.

error
object | null
required

Why the request failed once status is failed, else null.

status_url
string<uri>
required

Poll this URL for the request.

cancel_url
string<uri>
required

POST to this URL to stop the request.

Last modified on September 17, 2026