FXI Studio

Returns how many credits are left on the signed-in FXI Studio account and the name of its plan.

get_credits

Returns the status, per-clip progress, credits used and clip URLs for a frame_chain or compose_scene task. Status is pending, running, succeeded, failed or cancelled.

get_task

Generates one short video clip from a written brief, optionally using up to 4 of your saved characters as references and one of your saved images as the opening frame. Spends credits. Returns a task id; check it with get_task. For full control over a single shot, use generate_video instead.

compose_scene

Generates one video clip from a prompt, with optional start and end frame images, duration and aspect ratio, and saves it to your FXI library. Spends credits. Returns a generation id; check it with get_generation (clips usually take 1 to 3 minutes). Setting both start and end frames makes the clip move from one to the other.

generate_video

Generates one image from a prompt, with an optional reference image and aspect ratio, and saves it to your FXI library. Spends credits. Returns the image URL when ready (usually within 25 seconds), or a generation id to check with get_generation.

generate_image

Generates 2 to 8 video clips in order, where each clip starts from the last frame of the previous clip so motion carries across shots. The first clip starts from your image. Spends credits per clip; a clip that cannot start is not charged. Returns a task id; check progress and clip URLs with get_task. Returns separate clips, not one joined file.

frame_chain

Returns one of your saved generations by id: media URL, prompt, type, model name, status and credits used. Use it to check an image or video that was still in progress.

get_generation

Lists the available image and video generation models, grouped by role (fast stills, high-quality stills, fast video, hero shots, transitions, video with sound), with each model's output type (image or video) and a one-line description. Each entry includes the "model" value to pass to generate_image or generate_video. Optionally filter by role or output_type.

list_models