aicut

Returns the signed-in aicut account's token balance and plan tier. WHEN: before the first priced ask of a session, when the user asks what they have left, or after a generation fails for lack of tokens. `top_up_url` (the balance cannot pay for the cheapest generation, or a quote says `sufficient_balance: false`) is the ONLY link to give for adding tokens; never guess one. Prices: `list_models`, or

Returns the AI video, image and audio models this API can generate with: each model's exact parameters (names, allowed values, limits, defaults), the media inputs it takes and its pricing. WHEN: call this, NARROWED and never as the whole catalog, before the first `generate_video`, `generate_image` or `generate_audio` of a session: model ids cannot be guessed, nor can the resolutions, durations or

Returns a step-by-step recipe as text: `story-episode` (an AI Video Story episode, end to end), `starter-video`, `starter-image`, `starter-audio` (a first generation), `fake-text` and `image-story` (write the script), `niche-run` (a niche from `list_niches`), `talking-avatar` (a picture speaks a script), `motion-control` (a picture copies a clip's motion). Read the recipe before the first call of

Starts an AI video on the signed-in account, opens the aicut card and returns the job id at once; it does NOT wait. WHEN: the user asks for a video. Call `list_models` first this session (an unpublished combination is rejected); see `get_recipe` `starter-video`. CONSENT: a real person's picture only with their permission, never a public figure or celebrity. `seedance-2.5` and `seedance-2.0-mini` o

Returns the current state of one video generation: a SINGLE, IMMEDIATE read that waits for nothing. WHEN: only when you need one job's raw fields now (what it cost, whether it was refunded, why it failed). It is not how you wait (`wait_for_generation` is) and not how you show a video (the create already opened the card; `show_generation` brings back an earlier one). Do not poll it. When the user s

Deletes ONE video from the signed-in account's library: any of its own videos, in any state (finished, failed or still generating), exactly like the delete button in the web app. WHEN: the user asks to remove a video or tidy up after a failed one (a story episode whose writer failed, `story.stage: "writing_failed"`, charged nothing and can simply be left). NO REFUND, and say so first when the user

Returns the signed-in account's videos, newest first, one page at a time (pass `cursor` from the previous `next_cursor` while `has_more` is true). WHEN: the user asks what they have made, or you need a video from an earlier session. It is the whole library, including videos made in the web app and with products this API cannot create. THIS IS HOW YOU FIND A STORY EPISODE, and every story tool need

Increases an existing image's resolution and returns the new job's id immediately (it does NOT wait). Same image, more pixels. WHEN: the user asks to upscale, enhance, sharpen or increase the resolution of a picture they have, including one an earlier `generate_image` returned. It is not how you change what is IN the picture (`generate_image` with the picture as a reference). WHICH MODEL (`upscale

Takes a video and a description of what to change and generates the SAME clip with those changes applied (different characters, clothes, setting) while the camera move, timing, framing and the performers' motion stay as they were. Returns the new job's id immediately. WHEN: the user wants to restyle, recast or reskin footage they already have ('make the crowd elderly', 'put them all in suits', 'ma

Increases an existing video's resolution (2x, 3x or 4x) and returns the new job's id immediately. It does NOT wait for the result and does not change the content: same shot, more pixels. WHEN: the user asks to upscale, enhance, sharpen or increase the resolution of a video they already have. It is not how you make a video look different (that is a new generation). THE CARD: this call already opene

Generates a NEW segment that continues an existing video from its final frame and returns the new job's id immediately; the result is the original clip with the new segment joined on. WHEN: the user asks to extend, continue or lengthen a video, or wants to see what happens next in a clip they have. Call `list_models` first if you have not this session: `model` and the allowed `aspect_ratio`, `reso

Takes a picture of a character and a reference video and generates a video of THAT character performing the reference's motion (a dance, a walk, a gesture). Returns the new job's id immediately. WHEN: the user wants their character to dance, copy a move or perform a clip's motion. The clip supplies the MOVEMENT only; the character comes entirely from the picture. CONSENT: a real person's picture o

Takes a picture of a person and an audio file and generates a video of THAT person speaking or singing the audio, lip-synced. Returns the new job's id immediately; the result is exactly as long as the audio. WHEN: the user wants a talking avatar, a presenter or a voiceover on a face. The picture supplies the person; the audio supplies the performance AND the length. CONSENT: only a picture of the

OPENS A FILE PICKER RIGHT HERE, in this conversation: the user presses a button, chooses a video OR PHOTO from their own computer and watches it upload, and then it is on their aicut account for every tool. No link, nothing to paste. CALL IT IMMEDIATELY, WITHOUT ASKING ANYTHING FIRST, the moment the user refers to a video or image file on their machine ('upscale the clip in my Downloads', 'use the

Puts a VIDEO OR IMAGE FILE FROM THE USER'S OWN MACHINE onto their aicut account so the generation tools can use it (every other tool takes a URL). It returns an upload target in two forms, a ready-to-run `curl_template` for you and a `browser_upload_url` for the user; then you call `confirm_upload`. CANNOT RUN A SHELL COMMAND ON THE USER'S OWN MACHINE (claude.ai, ChatGPT, Claude Desktop, the mobil

Checks the file uploaded to an `upload_media` target and makes it usable. Returns the media `url` to pass to other tools, the file's size, its `kind` (`video` or `image`), its measured `width` and `height` and, for a video, `duration_seconds`. WHEN: right after the bytes moved (the curl printed a 2xx, or the user says they finished on the `browser_upload_url` page). It checks that the CONTENTS mat

Generates an AI image on the signed-in aicut account and puts the aicut card in front of the user. It waits for the image server-side for as long as one request safely can (about 24 seconds), so it usually returns the finished image with its `url` directly. WHEN: the user asks for an image. Call `list_models` first if you have not this session (an unpublished combination is rejected). `get_recipe`

Returns the current state of one image generation: a SINGLE, IMMEDIATE read that waits for nothing. WHEN: only when you need one job's raw fields now (what it cost, whether it was refunded, why it failed). It is not how you wait (`wait_for_generation` is) or show an image (`generate_image` already opened the card; `show_generation` brings back an earlier one). Do not poll it. `status` is `queued`,

Returns the signed-in account's images, newest first, one page at a time (pass `cursor` from the previous `next_cursor` while `has_more` is true). WHEN: the user asks what they have made, or you need an image from an earlier session, for example to pass its `url` into `generate_video` as a start frame. It is the whole library, including images made in the web app.

Starts an audio generation on the signed-in aicut account, puts the aicut card in front of the user and returns the new job's id immediately. It does NOT wait for the audio. One tool for all three kinds, chosen by the `model` you pass: spoken voice-over, music and sound effects. WHEN: the user asks for speech, a voice-over, music, a soundtrack or a sound effect. Call `list_models` with `type: "aud

Returns the current state of one audio generation: a SINGLE, IMMEDIATE read that waits for nothing. WHEN: only when you need one job's raw fields now (what it cost, whether it was refunded, why it failed). It is not how you wait (`wait_for_generation` is) or show a clip (`generate_audio` already opened the card; `show_generation` brings back an earlier one). Do not poll it. `status` is `queued`, `

Returns the signed-in account's audio generations, newest first, one page at a time (pass `cursor` from the previous `next_cursor` while `has_more` is true). WHEN: the user asks what they have made, or you need a voice-over, track or sound effect from an earlier session. It is the account's top-level audio, including audio made in the web app; it excludes the clips other products generate INSIDE a

The WHOLE voice catalogue: every voice aicut can speak with, across ElevenLabs (platform stock AND this account's cloned and custom voices) and OpenAI. Free, instant. EVERY VOICE ID COMES FROM HERE: `generate_audio`'s `voice`, `generate_fake_text_video`'s `voice_left` / `voice_right` and `generate_image_story`'s `voice`. Never invent one (it fails AFTER the job exists and is charged); `list_models

Waits up to 15 seconds for an aicut generation to reach a terminal state, WITHOUT opening a card, and returns the compact status. SEVERAL ITEMS: quote each, ask once with the total, start them all (images with `wait: false`, distinct `idempotency_key`s or none), then make ONE call with `ids` (1 to 6 of `{id, media}`) instead of `id` and `media`. `terminal` is always present: `true` means nothing f

Shows an EARLIER aicut generation to the user again, in the aicut card: the video, image or audio itself, with what it cost and when it was made. WHEN: the user asks to see something they already have (from earlier in this conversation, or found with `list_videos` / `list_images` / `list_audio`): that is its only job. Each `generate_*` already put the card up on the call that started the job, so c

Starts an AI analysis of an existing video and returns the new analysis's id immediately (it does NOT wait). It reads the video and describes it in detail (what happens, who is in it, the on-screen text, the pacing and cuts) as free-form text, plus the platform's own metadata (title, author, view count) when it has any. It generates nothing: use `generate_video` for that. WHEN: the user wants to u

Returns the current state of one video analysis on the signed-in account, and its result once finished. WHEN: after `analyze_video`; poll every 5-10 seconds until `status` is `succeeded` or `failed`. While it is not terminal the response carries `poll_after_seconds`: wait that long rather than picking your own interval. TIMING: an analysis usually finishes in under a minute and can take a few minu

Returns the signed-in account's video analyses, newest first, one page at a time (pass `cursor` from the previous `next_cursor` while `has_more` is true). WHEN: the user asks what they have analysed, or before starting a new one (an analysis of the same video and window may already exist). It includes analyses started in the web app and TRANSCRIPTS (`analysis.format: "text"` rather than `"markdown

Returns the characters saved on this aicut account, newest first, one page at a time: `kind: "uploaded"` entries the user made from their own photos and `kind: "cast_member"` entries generated as AI Video Story cast. Each carries an id, a display name, a portrait `image_url` where one exists and, for cast members, the visual `world`. Read-only: it creates nothing and spends nothing. WHEN: the user

Lists aicut's AI Video Story series (niches): episodic short-video formats that generate a whole multi-scene episode from one idea. BROWSING IS `browse_series`' JOB: when the USER is choosing a series ('what series do you have'), call `browse_series` FIRST (a series is chosen BY EYE). THIS TOOL IS THE DATA READ behind that choice (prices, the duration ladder) and the fallback with no cards. Never

Returns ONE series' CURATED preset ideas (the authored cards the webapp shows on its idea step). Free, instant, creates nothing. THIS IS NOT THE DEFAULT WAY TO GET AN IDEA: invent three of your own, one line each, and sharpen them with the user in chat; call this only when the user asks what the SERIES itself suggests ('show me the ones from the app'). Then offer at most 3, one line each, as the s

Lists aicut's trend-template niches: one-shot video formats made from a few answers (and sometimes a picture), each at one price. AI Video Story series are `list_series`, not these. WITHOUT `slug`: the cards (`slug`, `name`, `description`, `suits`, `not_for`, `price`, `agent_supported`). Shortlist 3-5 that fit, saying what each makes and what it is NOT for; never dump the list. WITH `slug`: that O

Runs ONE niche on the signed-in account: starts the video, puts the aicut card in front of the user and returns the new job's id immediately. It does NOT wait for the video. WHEN: the user wants one of the formats `list_niches` lists. Read that niche in full first: `slug` and `revision` come from it, `values` answer its text and select inputs by `key`, `media` fills its image inputs. A setting you

PUTS THE SERIES CATALOGUE ON SCREEN as a grid of previews the user can look at and pick from, right in this conversation: each tile shows that series' 9:16 still, plays its demo clip in place, and choosing one (select a tile, then confirm) posts the choice into the chat as a message from the user. Free, instant, spends nothing. It is the answer to 'what series are there' on a client that renders c

Lists the AI-generated short-form videos aicut tracks as TRENDS: real TikTok videos, each in a published trend cluster (a niche: object-head drama, fruit drama, talking objects). It is aicut's own vetted /trends feed. Free, instant, creates nothing. EACH ROW: `id` (for `get_recreate_brief`), `url`, `caption`, `hashtags`, the engagement counts, `outlier_ratio` (how far the video beat its channel's

For making a NEW, original video in a trend's format, never a copy of it, its script or its characters: returns ONE trend video's public row, the NICHE it belongs to (the published cluster, with the premise a human wrote), a written `brief` you can hand to a create call as its idea, and `next_steps`. Free, instant, creates nothing. IT DOES NOT TELL YOU WHICH SERIES TO USE: `series.selected` is alw

Writes the CAST for an AI Video Story series (named characters, each with a role and a one-line description) as a DRAFT for the user to read. FREE: it spends no tokens, generates no portraits and saves nothing to the character library. WHEN: as soon as the episode idea is settled, on a series whose `cast.required` is true (or whose user wants custom characters). Do NOT ask permission: it costs not

BUYS the portraits for a cast draft: one image generation per member that still needs a face, at the chosen image model's rate, then saves every member to the user's character library. The cast's paid step (the webapp's 'Generate cast' button). WHEN: the user has READ the draft from `generate_cast`, accepted it, and said go to the price. Take the figures from the draft's own `portrait_models` (`pe

Redraws ONE cast member's portrait (the same character, a new image) and attaches it to that member: ONE image generation, not a new cast. WHEN: the user dislikes a member's face, or a portrait FAILED (the story create refuses a cast with a failed portrait and names this). `character_id` is the member's `id` from `generate_cast_portraits` or `list_characters` (kind `cast_member`). It draws the SAM

CHANGES ONE cast member into a different character: you pass a new one-line visual description, aicut rewrites the member's stored look from it and draws ONE new portrait (the rest of the roster is untouched). It is the tool for 'make the husband smaller and a white strawberry': NOT `regenerate_cast_portrait` (the SAME character again), nor a new `generate_cast` (it re-authors every member and re-

Starts an AI Video Story EPISODE (stage 1 of 3): the engine writes the multi-scene episode from your idea, draws the OPENING PICTURE OF EVERY SCENE, and PARKS for the user to look at them before any video generates. Returns immediately. Say 'the opening picture of each scene' to the user, never 'start frames' or 'frames review' (field names). WHEN: the series is picked and its FULL entry fetched (

Redraws ONE scene's opening picture of an episode parked at frames review (`story.stage: "frames_review"`), from the scene's own text, cast and continuity references. There is no prompt argument. WHEN: the user dislikes THE PICTURE itself (hands, framing, a face that came out wrong, a failed lane). `scene_index` is that frame's zero-based `scene_index` in `get_video`'s `story.frames`. If what HAPP

CHANGES WHAT HAPPENS IN ONE SCENE of an episode parked at frames review and redraws its opening picture from the change. You pass a PLAIN SENTENCE ('the kid should look super sad', 'move it outside at night'); aicut rewrites that scene's setting / people / action text from it and draws the new picture: ONE image generation. The change STICKS (the scene video made at fire uses it). It is the tool f

REMOVES one scene from an AI Video Story episode parked at frames review. The scene's VIDEO is never generated or charged, so the fire quote and charge drop by exactly that scene's price. Free: it spends nothing (the scene's start frame was already charged at create and is not given back). WHEN: the user looked at the frames and wants a scene GONE rather than redrawn, before `fire_story_video`. `s

FIRES a parked AI Video Story episode (stage 2 of 3): generates every kept scene's VIDEO from its reviewed picture. The paid step after review; nothing renders yet. WHEN: `story.stage` is `frames_review`, the user has looked at the pictures and any redraws are done; cut scenes first with `remove_story_scene` (a removed scene's video is never generated or charged). Always `estimate_only: true` firs

RENDERS an AI Video Story episode into its final delivered file (stage 3 of 3), after the scene videos are done. It is composed SERVER-side from the stored episode (scenes, captions, music, title card, watermark policy); you pass only the episode id. WHEN: `get_video` shows `succeeded` or `story.stage: "ready_to_render"` (an episode edited in the web editor renders with those edits; a later render

CREATES a fake-text video: a phone chat conversation that types itself out over a gameplay or green-screen background, every line read aloud in the voice you pick for that side. YOU WRITE THE SCRIPT: there is no writer behind this endpoint, and the `messages` array you send IS the conversation, in that order, one `{text, from}` per chat bubble (`get_recipe` `fake-text` has the format advice and a

CREATES an AI image story: a narrated script turned into a sequence of AI-generated images, read aloud with captions over it. Suited to facts, history, horror, storytime and explainers. YOU WRITE THE SCRIPT, AND ONLY THE SCRIPT: the `text` you send is the narration that is spoken, verbatim, in that order (`get_recipe` `image-story` has the writing advice and a worked example). Show it to the user

Lists aicut's authored image-story STYLES: named looks (a character, a rendering treatment, an art direction) that every scene of the video is drawn in. Free, instant, creates nothing. OPTIONAL, NOT THE DEFAULT: most image stories use aicut's ordinary photorealistic look, which is also the cheapest; call this when the user asks what looks exist or wants a consistent stylised world. IT CHANGES THE

Returns the social accounts this aicut user has connected for publishing, with the id `prepare_post` takes, plus `connect_url`. WHEN: before any posting attempt, and whenever the user asks where they can post. Each entry carries its `platform` (tiktok, youtube or instagram) and `schedule_custody` (`aicut_scheduler`: a scheduled post waits in aicut; `platform`, i.e. YouTube: the video is uploaded a

Puts a video NOT made on aicut (an upload, or a public https MP4/MOV link) on this account as a finished video; returns the `id` for `prepare_post`. Free. A local file: upload it, pass the `confirm_upload` url. A link costs one ingest slot. Only import what the user may post. IDEMPOTENCY: a reused `idempotency_key` REPLAYS the first job whatever the settings: never reuse one for a new generation (

Stages a post of one of this account's finished videos to one of its connected TikTok, YouTube or Instagram accounts and returns the post id `publish_post` takes. NOTHING IS PUBLISHED BY THIS CALL. WHEN: after `list_social_accounts` gave you an account id and you have a finished video's id (`list_videos` / `get_video`, `status` `succeeded`). AN AI VIDEO STORY EPISODE MUST BE RENDERED FIRST: it rep

Sends a post staged by `prepare_post`, or schedules it. Irreversible: the post goes out under the user's own name and cannot be taken down from aicut. It is for a post the user has confirmed: either in chat, after a question that named the account, the text, the visibility and any scheduled time (a bare 'yes' confirms only when that question about this post was the message immediately before it),

Returns what the PLATFORM says happened to a post, plus `post_id` once it is live and `fail_reason` when it is not. Statuses: `prepared` (staged, nothing sent), `scheduled` (due at `scheduled_at`; `schedule_custody` says whether aicut or the platform holds it), `submitted` (handed to aicut's YouTube or Instagram poster, nothing confirmed), `publishing` (TikTok took the job and is fetching the file

OPENS THE PUBLISH CARD RIGHT HERE for a post `prepare_post` has already staged: the user watches the actual video, sees the destination account, edits the caption, picks the visibility, sets the commercial disclosure themselves, ticks a box saying they want it posted and confirms twice. NOTHING IS PUBLISHED BY THIS CALL OR BY THE CARD. CALL IT IMMEDIATELY AFTER `prepare_post` ON ANY CLIENT THAT RE