add_moment
ChatGPTOptional — except for uploaded videos. Adds a required moment: a scene the ad must contain; the script is written around it and the storyboard places it where it fits. Without moments the script and storyboard decide everything, which is fine. BUT an uploaded video only appears in the ad through a custom-footage moment — uploading it alone does nothing; give footage (its media_id and the range to play, muted). Types: product-shot (someone holds/uses the product, face in frame), product-shot-faceless (close look at the product, no face), b-roll (supporting footage: a place, object, mood), product-action (the product in motion, from its photos), talking-person (the narrator says dialogue to camera), custom-footage. Tag who's in frame in the description with @[Name] from get_project's cast (e.g. "@[Main Character] pours @[Glow Serum] into her palm"). Add moments before generate_script; the total must fit the script's length.
add_subject
ChatGPTOptional. Adds someone or something to the cast beyond the narrator and the product — a side character (kind person), a pet, or an object — so moments can feature them by tagging @[Name]. Skip it unless the ad needs them. The image is either yours (image_url, or upload_id from create_media_upload; a photo meeting the requirements, ≥480×480 px) or generated (generate: true, a few credits, ready in about a minute: a person is drawn from archetype, the actor form's fields; a pet or object from description). Add subjects before the moments that tag them, and both before generate_script.
create_media_upload
ChatGPTFor a photo or video file on the user's machine (needs an agent that can run curl or make HTTP requests). Returns a one-time upload_url: PUT the file's bytes there with its Content-Type header (the returned curl does exactly that), then call finalize_media_upload. Media requirements: - Photos: JPEG, PNG or WebP; at least 480×480 px; at most 15 MB. Clear, well-lit shots of the real product, one product per photo, no collages or heavy text overlays. - Videos: MP4 or MOV (H.264 recommended); 1–60 seconds; at most 50 MB; vertical 9:16 recommended. Clips play muted. A video only appears in the ad through a custom-footage moment (add_moment, type custom-footage): uploading it alone does nothing. - Physical products: tag every photo with the view it shows (front, left, rear, a 3/4 view…, detail for a close-up, size-reference for a scale shot). A front photo is strongly recommended. - detail photos, and every photo of a digital product or service, need a description (≤240 characters) of what they show. - At most 8 files per call.
create_project
ChatGPTStarts a new video ad for a product. Give product_url to import it, or product_name and product_description; add photos and videos by URL with media. Returns the project and the next step.
finalize_media_upload
ChatGPTChecks a file PUT to an upload_url against the requirements and adds it to the project's media. If file inspection, classification, or saving fails, the uploaded file is deleted from Retiplex storage and the error is returned. A deleted upload must be uploaded again before retrying.
generate_script
ChatGPTWrites the voiceover script from the brief (calling it again writes a different variation), or saves script if you pass one. target_seconds sets the length (10–120s; trial accounts less). Changing the script after a storyboard means regenerating the storyboard.
generate_storyboard
ChatGPTPlans the scenes from the script, actor and product photos. Runs in the background for 1–3 minutes: poll get_project until storyboard.scenes > 0, then review the scenes with the user. Needs a paid plan. Regenerating replaces the scenes.
get_account
ChatGPTThe signed-in user's Retiplex account: credit balance, plan, whether it can generate videos, and the longest script it allows. Call this first, and before anything that spends credits.
get_project
ChatGPTA project's state: product and its media (each with what it still needs), the cast (the @[Name] tags scenes can use), moments, brief, actor, script, storyboard (with its scenes once generated) and the current step, plus nextTool to call. Poll this while a storyboard or a subject image generates.
get_video_status
ChatGPTProgress of a project's video generation, and the finished video's URL once it's rendered. Poll every couple of minutes, not faster.
list_formats
ChatGPTThe ad formats (narrative templates) a project can use, for set_creative_brief. custom has no fixed structure: describe the ad as an idea instead.
list_projects
ChatGPTThe user's 20 most recent video projects.
remove_moment
ChatGPTRemoves a required moment (from get_project's moments) from the ad.
remove_subject
ChatGPTRemoves a subject (or a pending/failed subject image) that no moment tags.
resume_video_generation
ChatGPTRetries a failed or stalled video generation from where it stopped, when get_video_status suggests it.
set_actor
ChatGPTCasts the on-camera narrator and renders their portrait, which every scene is generated from — the app's actor form. Leave archetype out to cast someone fitting the audience automatically. Pass archetype to design them: for a project with an actor, only the fields you give change (e.g. just clothing); a first actor needs every field except facialFeatures. Each call renders a new portrait (1 credit); show the user previewUrl.
set_creative_brief
ChatGPTSets the ad's format and campaign facts (who it's for, the benefit to sell, the action to drive). Facts you leave out are deduced from the product (a few credits). For the custom format pass idea — the ad you have in mind, in your own words — and a full brief is written from it.
set_product
ChatGPTChanges a project's product, or adds photos and videos to it by URL. Same inputs as create_project.
start_video_generation
ChatGPTGenerates the video from the storyboard: hook, voice, every scene, then the final render. Takes 10–30 minutes and spends the estimate get_project returns (estimatedVideoCredits). Confirm that with the user and pass it as max_credits. Poll get_video_status.
update_product_media
ChatGPTClassifies a product photo or video (its view angle, its description) or removes it. Look at each photo get_project lists with needs, and tag it. Media requirements: - Photos: JPEG, PNG or WebP; at least 480×480 px; at most 15 MB. Clear, well-lit shots of the real product, one product per photo, no collages or heavy text overlays. - Videos: MP4 or MOV (H.264 recommended); 1–60 seconds; at most 50 MB; vertical 9:16 recommended. Clips play muted. A video only appears in the ad through a custom-footage moment (add_moment, type custom-footage): uploading it alone does nothing. - Physical products: tag every photo with the view it shows (front, left, rear, a 3/4 view…, detail for a close-up, size-reference for a scale shot). A front photo is strongly recommended. - detail photos, and every photo of a digital product or service, need a description (≤240 characters) of what they show. - At most 8 files per call.