Production tools
Images, videos, voice-overs and scripts: quote and confirmation, every recipe, the library, format adaptation, broadcast quality, sharing and characters.
Tool names and descriptions are generated straight from the server code; the descriptions are the original English text the assistant sees.
Read tools9 tools
list_productions
قراءة0 creditsProduction library: images, videos, voice-overs and scripts (generated, uploaded, adapted to ad formats) with status (queued, rendering, ready, needs_provider, failed, cancelled), the openable file URL when ready, the hook/CTA, why a file is waiting, the remaining time of a running job, whether a failed one can be retried (retry_production), favorite, recipe, variation group and its comparison result, review link decision and comments count, and the campaign-level ad results when used in a campaign. Filter by status, kind, text, favorites or group; paginated (total, next_offset). Read-only, free.
| Parameter | Type | Description |
|---|---|---|
production_idOptional | string | one production with its full details (script, review, results) |
statusOptional | queued | rendering | ready | needs_provider | failed | cancelled | draft | — |
kindOptional | ugc_video | short_video | image | voice | script | — |
searchOptional | string | text in the title or request |
favoriteOptional | boolean | only starred productions |
group_idOptional | string | one variation group (batch.group of an item) |
limitOptional | integer (1–60) | newest first (default 10) |
offsetOptional | integer (0–…) | next_offset of the previous page |
get_production_options
قراءة0 creditsProduction screen options: which kinds and recipes are open, the engine and price of each kind per quality tier (plan credits or USD balance), the pricing mode and what is left, resolutions, aspects, styles, languages; topic=characters saved characters; topic=videos ready videos that can be dubbed; topic=formats ad placement formats. Call it before quoting instead of guessing prices. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
topicOptional | overview | characters | videos | formats | — |
platformOptional | string | topic=formats: meta | google | tiktok | linkedin | … |
typeOptional | image | video | topic=formats |
get_production_quote
قراءة0 creditsRead a production quote: status (open, approved, expired, cancelled), price, what it will produce, expiry and the production it started. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
quote_idRequired | string | — |
production_preflight
قراءة0 creditsPre-flight check of a ready file: without a target it lists the placements and broadcast profiles it can be checked against; with format_id or profile it measures the file itself (aspect, resolution, length, size, audio and loudness, captions and safe area, call to action, opening, AI disclosure) and returns pass / warn / fail. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | production id (from list_productions or quote/start results) |
format_idOptional | integer (1–…) | ad placement to check against |
profileOptional | tv_pal | tv_ntsc | ctv | broadcast profile to check against |
get_production_masters
قراءة0 creditsBroadcast-quality master copies of a ready video: available profiles (TV PAL 1080p25 −23 LUFS, TV NTSC 1080p29.97 −24 LKFS, connected TV), codecs, allowed lengths, the source's measurements and the copies made with their technical reports. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | ready video |
get_production_film
قراءة0 creditsScenes of a brand film (stored clips), editing options and version info. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | brand film |
get_production_share
قراءة0 creditsReview state of a production: its latest review link (expiry, scope), the reviewers' decision (pending, approved, changes requested) and their comments. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | production id (from list_productions or quote/start results) |
get_production_wallet
قراءة0 creditsProduction pricing mode (plan credits or USD balance), remaining credits, production balance with reserved amount and monthly limit, this month's spend and the balance ledger (paginated). Read-only, free.
| Parameter | Type | Description |
|---|---|---|
ledger_limitOptional | integer (1–200) | — |
beforeOptional | integer (1–…) | next_before of the previous page |
get_production_download
قراءة0 creditsDownload address of a ready file. Without format: the original file's address. With format (images only): a converted PNG / JPG / WEBP copy at a signed address that expires in minutes. Read-only, free.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | ready production |
formatOptional | png | jpg | webp | images: converted copy in this type |
Write tools19 tools
suggest_production_hooks
كتابة1 credits5–8 opening line (hook) suggestions for the first seconds of a video or the headline of an image, from the brand profile and the brief; without a text model it returns rule-based patterns, never invented claims. Pass the chosen line to quote_production hook (or hooks with variations). Produces nothing.
| Parameter | Type | Description |
|---|---|---|
kindRequired | ugc_video | short_video | image | — |
briefRequired | string | — |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
quote_production
كتابة0 creditsStep 1 of a production: get a QUOTE for anything the Production screen makes — image, short / UGC video, voice-over, script and every recipe (product photo, edit, persona, AI influencer, AI avatar, brand film, single scene, dubbing, campaign pack), with quality tier, aspect, resolution, source file, character, opening line and 2–4 variations. Returns what will be produced, the price (plan credits or USD balance — the same price as the dashboard) and until when it is valid. NOTHING is produced or charged here: show the price to the user, wait for their explicit confirmation, then call start_production with the quote id.
| Parameter | Type | Description |
|---|---|---|
kindOptional | ugc_video | short_video | image | voice | script | what is produced (with like_production_id it may be omitted) |
briefOptional | string | what to produce: product / service, message, audience, style; for recipe=edit the change to make |
titleOptional | string | — |
recipeOptional | product | edit | persona | influencer | avatar | film | scene | dubbing | pack | ready-made flow: product = from a product photo (reference_id, style); edit = new version of a ready file (reference_id, brief = the change); persona = AI portrait to save as a character (kind=image); influencer = with a saved VIRTUAL character (character_id); avatar = with a consented REAL person's character (character_id); film = multi-scene brand film (kind=short_video, scenes, captions, end_card); scene = regenerate one scene of a ready film (reference_id = film, scene = number; only that scene is charged); dubbing = ready video in another language (reference_id, language); pack = campaign content pack (kind=image, formats, video) |
tierOptional | string | quality tier (economy / balanced / premium) or, for videos, a named video engine such as bytedance/seedance-2.0 (see the catalog: tiers with engine_name); changes the price (default: the route's model) |
resolutionOptional | 1K | 2K | 4K | images only |
aspectOptional | 1:1 | 4:5 | 3:4 | 2:3 | 9:16 | 16:9 | 3:2 | 4:3 | images: all; videos: 9:16 / 16:9 |
styleOptional | studio | lifestyle | outdoor | flatlay | hand | recipe=product: scene preset |
reference_idOptional | string | production id of the source file (product photo, file to edit, video to dub, film) |
character_idOptional | string | recipe=influencer / avatar: character id (get_production_options topic=characters) |
scenesOptional | integer (0–12) | film: scene count (0 = default) |
captionsOptional | boolean | film: on-screen captions (default true) |
end_cardOptional | boolean | film: closing card with logo (default true) |
sceneOptional | integer (0–12) | recipe=scene: number of the scene to regenerate (from 1) |
languageOptional | tr | en | de | es | fr | nl | pt | zh | pl | ja | ar | hi | it | ru | ko | bn | ur | id | vi | th | he | recipe=dubbing: target language |
formatsOptional | array<integer> | recipe=pack: ad format ids (get_production_options topic=formats) |
videoOptional | boolean | recipe=pack: also a short video from the main image |
hookOptional | string | opening line (suggest_production_hooks); recipe=scene + scene=1 changes only the film's opening |
angleOptional | problem | moment | detail | direct | creative angle (ignored with variations: each variation gets its own) |
variationsOptional | integer (2–4) | batch: N separate productions from one request, each with another angle; the TOTAL price is returned |
hooksOptional | array<string> | with variations: opening lines given to the variations in order |
campaign_idOptional | string | campaign id or name to link the production to |
like_production_idOptional | string | "more like this": copy the settings (kind, brief, recipe, character, tier, style, aspect, hook, angle) of this production; given arguments override them |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
start_production
كتابةIrreversible0 creditsStep 2: start the production of a quote the user has CONFIRMED after seeing its price. The price is reserved from the balance or the plan credits are used now (exactly as the dashboard's "Confirm and produce"); if the credits or balance do not cover it nothing starts (credits_exhausted / insufficient_balance with the needed amount). Call it only when the user explicitly asked to go ahead. The same quote never starts twice. Returns the production (queued / rendering / ready); files take minutes — check them with list_productions.
| Parameter | Type | Description |
|---|---|---|
quote_idOptional | string | — |
quote_idsOptional | array<string> | all quotes of one variation group, started with one confirmation |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
cancel_production
كتابة0 creditsCancel a queued production that has not reached the provider yet; any reserved amount is returned. A file the provider is already rendering cannot be stopped (error rendering).
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | production id (from list_productions or quote/start results) |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
retry_production
كتابة0 creditsFor a failed or cancelled production: a NEW quote with the same settings at today's price. Charges nothing; start it with start_production after the user confirms the price.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | production id (from list_productions or quote/start results) |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
delete_production
كتابةIrreversible0 creditsPermanently delete productions and their files (with their format versions). Cannot be undone — only when the user explicitly asks to delete these files. A file used in a campaign (in_use) or still rendering (active) is not deleted; the result lists each one.
| Parameter | Type | Description |
|---|---|---|
production_idOptional | string | production id (from list_productions or quote/start results) |
production_idsOptional | array<string> | several productions at once (up to 24) |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
set_production_favorite
كتابة0 creditsStar or unstar a production (the favorites filter of list_productions and the dashboard).
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | production id (from list_productions or quote/start results) |
favoriteRequired | boolean | — |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
import_production_from_url
كتابة1 creditsStart from a product page: the server reads the page safely (http(s) only, internal network closed, redirects re-checked, size limited) and returns its title, description and price; the main image is saved to the library as a product photo. The user must confirm the rights to the content (confirm_rights=true); it is recorded. Use the image as reference_id in quote_production. 1 credit.
| Parameter | Type | Description |
|---|---|---|
urlRequired | string | public product page (http / https) |
confirm_rightsRequired | boolean | the user confirmed they may use the page's text and image |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
upload_production_image
كتابة1 creditsAdd the user's own image to the production library (product photo, logo-free visual): the file type is checked from its bytes, it is re-encoded and its location data (EXIF) is removed; PNG, JPEG or WEBP up to 12 MB. From a URL only public addresses are read (internal addresses refused). Use it as reference_id or with adapt_production_formats. 1 credit.
| Parameter | Type | Description |
|---|---|---|
image_base64Optional | string | PNG / JPEG / WEBP, optionally a data: URL |
source_urlOptional | string | public http(s) image address to copy instead |
titleOptional | string | — |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
adapt_production_formats
كتابة0 creditsAdapt a ready image to the aspect ratios of chosen ad placements (up to 12), keeping the headline, call to action and logo inside the safe area. Each version becomes a library file. Free, on our own server.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | ready image to adapt |
formatsRequired | array<integer> | ad format ids (get_production_options topic=formats) |
headlineOptional | string | — |
ctaOptional | string | — |
logoOptional | boolean | brand logo in the safe area (default true) |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
create_production_master
كتابة0 creditsRequest a broadcast master copy of a ready video (encoded on our own server, free, rate-limited) with a technical report. Technical preparation only: it does not guarantee a broadcaster's acceptance; interlaced and XDCAM MXF are not produced.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | ready video |
profileRequired | tv_pal | tv_ntsc | ctv | — |
codecRequired | prores | h264 | prores = ProRes 422 HQ .mov · h264 = H.264 High .mp4 |
secondsOptional | integer (0–60) | exact spot length (0 = the source's length) |
pillarboxOptional | boolean | fit a vertical / square source into 16:9 with black side bars |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
delete_production_master
كتابةIrreversible0 creditsPermanently delete a master copy and its file. Cannot be undone — only when the user explicitly asks.
| Parameter | Type | Description |
|---|---|---|
master_idRequired | string | master copy id (get_production_masters) |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
edit_production_film
كتابة0 creditsRe-cut a brand film: scene order, on-screen captions, closing card. Free, on our own server; makes a new version and keeps the old one. Regenerating a single scene is charged and goes through quote_production recipe=scene.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | brand film |
orderOptional | array<integer> | new scene order: every scene number once |
captionsOptional | boolean | — |
end_cardOptional | boolean | — |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
create_production_share
كتابة0 creditsCreate a time-limited review link (1–90 days) that clients or the team open without an account: they comment and approve or request changes. The address is returned only once; earlier links of the production are closed.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | ready image or video |
daysOptional | integer (1–90) | link lifetime in days (default 14) |
scopeOptional | single | group | single = this production · group = its whole variation group |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
revoke_production_share
كتابةIrreversible0 creditsClose every open review link of a production at once; a closed link cannot be reopened (create a new one). Only when the user explicitly asks.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | production id (from list_productions or quote/start results) |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
create_production_character
كتابة0 creditsSave a ready face image as a character for consistent content. type=virtual: an AI influencer. type=real: a real person's AI avatar — allowed only with the consent statement the USER gives in their own words (the person's name, basis: self or written permission, confirmed=true); never fill it in on the user's behalf. The statement is recorded with the account and time.
| Parameter | Type | Description |
|---|---|---|
nameRequired | string | — |
typeRequired | virtual | real | virtual = AI influencer · real = a real person (AI avatar) |
image_idRequired | string | ready face image in the library (generated portrait or uploaded photo) |
descriptionOptional | string | — |
consentOptional | object | required for type=real |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
delete_production_character
كتابةIrreversible0 creditsDelete a character (for a real person this withdraws the consent). Cannot be undone — only when the user explicitly asks; files already produced stay.
| Parameter | Type | Description |
|---|---|---|
character_idRequired | string | — |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
set_production_monthly_limit
كتابة0 creditsSet or remove the monthly spending limit of the production balance (USD). Productions that would pass it are refused (monthly_limit). Only when the user asks.
| Parameter | Type | Description |
|---|---|---|
monthly_limitOptional | number (0–1000000) | USD per month |
clearOptional | boolean | remove the limit |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.
add_production_to_campaign
كتابة0 creditsMake a production the creative of a campaign (a draft creative card). On Meta and Google the file is used when the campaign is published; a live ad does not change by itself. The production card then shows the campaign's results.
| Parameter | Type | Description |
|---|---|---|
production_idRequired | string | ready file (or a script for a text card) |
campaignRequired | string | campaign id or name |
Write tool: the call first produces a preview; the change reaches the platform only after you approve it.