list_formats
List video formats
List video formats (call this before create_lesson when the user names a style)
Use when someone asks which styles exist, or before create_lesson if they said a style ("short", "explainer", "vertical"). Returns format ids to pass to create_lesson; never hard-code an id, read it here. No minutes are spent.
Takes no parameters.
list_voices
List narrator voices
List narrator voices (call this before create_lesson when the user names a voice, a tone or a gender)
Use when someone asks which voices exist, wants a female or male narrator, a calm or lively tone, or English narration. Returns each voice with its name, a one-sentence tone, language (tr or en), gender, accent, tier and a short audio sample. Pass a voice `key` to create_lesson. Optional `language` narrows the list. Premium voices spend 1.5x minutes. No minutes are spent here.
Parameterslanguage
list_lessons
List my lessons
List this account's recent lessons (use when someone asks "my videos", "what did I make", or wants to continue an earlier one)
Use when the user refers to their own earlier work: their videos, the lesson they started yesterday, the one waiting for approval. Returns the newest lessons with id, title, status, minutes and a link to open each. Read-only and free. Pass `status` to narrow (queued | rendering | done | failed) and `limit` (default 20, max 50).
Parameterslimitstatus
create_lesson
Create a lesson
Create a narrated video lesson from a document, text or web page (use when someone wants a document turned into a training, safety or procedure video)
Use when the user brings a document, a block of text or a web page and wants a video, a lesson, an explainer or a summary video of it. Accepted sources: a file (PDF, DOCX, PPTX, MD or TXT, max 50 MB) sent as multipart, which the local MCP server takes as `file_path`; plain `text` (max 5 MB); or a public http(s) `url` whose readable text becomes the document. Every on-screen sentence cites the source paragraph it came from, so use this when the user needs traceable training, safety or procedure videos. Narration is Turkish. Returns a lesson id immediately; nothing renders and no minutes are spent until approve_lesson. Follow it with get_lesson until the storyboard needs approval. With an Idempotency-Key the same request inside 24h returns the same lesson (same key, different body is 409). API documentation: https://zipirapp.com/en/api/
Parametersurllangtexttitlevoiceformat
get_lesson
Get lesson status
Check a lesson's status (poll this after create_lesson and after approve_lesson)
Use whenever you need to know where a lesson stands: after creating it, while it renders, or before downloading. `status` is the machine state (queued | rendering | done | failed), `phase` is finer, `needs_approval` is true while the storyboard waits for a human, and `next` says which call to make next. Costs no minutes.
Parametersidrequired
approve_lesson
Approve and render (spends minutes)
Approve the storyboard and start rendering (the only call that spends the account's minutes)
Use only after the user has seen the storyboard and agreed: this is the panel's approval button. The minutes for the lesson are held at this call and the render is queued. Do not approve on the user's behalf without their go-ahead. Check get_usage first if the balance may be tight.
Parametersidrequired
get_download
Get download link
Get a signed download link for the finished video (use when the video is ready and the user wants the file)
Use once get_lesson says the video is done. Returns a URL (valid 900 s) to the MP4, not the file itself: hand the link to the user or fetch it. `variant=720` is the light copy every plan gets, `variant=1080` is full quality and needs a paid plan.
Parametersidrequiredvariant
get_usage
Get minute balance
Check remaining video minutes before spending any (call this before approve_lesson if unsure)
Use when the user asks how much is left, or before approve_lesson when the balance may be tight. `remaining` is what this key can spend now: the account's own balance as the billing page shows it (plan minutes left plus bought packs, or the free trial plus packs), narrowed by the key's own monthly cap if it has one; never a second rule. `used` is this key's minutes in the current period (finished videos plus minutes held for its lessons still rendering); `limit` = used + remaining. approve_lesson answers 402 quota_exceeded when the lesson does not fit.
Takes no parameters.