{"info":{"_postman_id":"4b7a5e87-2b6f-4040-8f23-1f7165ad33a9","name":"Revid Public API v3 - Master Collection","description":"

Master collection for POST /api/public/v3/render with workflow-focused examples.

This collection now embeds a condensed field reference designed for both humans and AI agents.\nOpen the request Field Definitions (v3) to see workflow requirements, parameter meanings, enums, ranges, and legacy passthrough notes.

Highly recommended workflow:

Configure your video on https://www.revid.ai/create
Click Get API code
Use that exact JSON payload in this API

Related docs:

Live JSON docs: GET https://www.revid.ai/api/public/v3/render
OpenAPI spec: https://www.revid.ai/postman/revid-public-v3-render.openapi.json
Legacy V2 API: https://documenter.getpostman.com/view/36975521/2sA3kPo4BR

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36975521","collectionId":"4b7a5e87-2b6f-4040-8f23-1f7165ad33a9","publishedId":"2sBXcGEfaB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-25T13:57:15.000Z"},"item":[{"name":"Get v3 Master Docs","id":"65df4806-7d9d-479e-af28-5df7a25f8587","request":{"method":"GET","header":[],"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"65df4806-7d9d-479e-af28-5df7a25f8587"},{"name":"Get v3 OpenAPI Spec","id":"ec97720e-83bb-424f-9840-9160f854eef7","request":{"method":"GET","header":[],"url":"https://www.revid.ai/postman/revid-public-v3-render.openapi.json","urlObject":{"path":["postman","revid-public-v3-render.openapi.json"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec97720e-83bb-424f-9840-9160f854eef7"},{"name":"Field Definitions (v3)","id":"0511798d-6955-4d43-bffb-deef271ac49e","request":{"method":"GET","header":[],"url":"https://www.revid.ai/api/public/v3/render","description":"

Revid v3 Field Definitions (Condensed)

Canonical shape:

{\n  \"webhookUrl\": \"https://your-webhook.com/revid\",\n  \"workflow\": \"script-to-video\",\n  \"source\": {},\n  \"media\": {},\n  \"voice\": {},\n  \"captions\": {},\n  \"music\": {},\n  \"avatar\": {},\n  \"options\": {},\n  \"render\": {},\n  \"advanced\": { \"customCreationParams\": {} }\n}\n

Key rules:

media.generateVideos is removed and auto-derived.
media.animation applies only for media.type = moving-image.
media.hasEnhancedGeneration* are derived from media.imageModel.
Prompt tuning is under source: source.stylePrompt, source.durationSeconds.
Music generation fields are under music: music.generateMusic, music.generationMusicPrompt.
For audio-to-video, options.useWholeAudio defaults to true.
Omit defaults for compact payloads (false/null flags and options.outputCount when 1).

Workflow requirements:

script-to-video: source.text
audio-to-video: source.url
avatar-to-video: source.text + avatar.url
prompt-to-video: source.prompt
ad-generator: source.prompt or media.provided[]
music-to-video: source.url
article-to-video: source.url
motion-transfer: source.url + media.provided[]
caption-video: source.url
static-background-video: source.text or source.url

Core enums:

media.type: moving-image, ai-video, video, stock-video, custom
media.animation: none, soft, dynamic, depth
captions.position: top, middle, bottom
music.syncWith: beats, lyrics

Additional Parameters (New in v3):

music.soundWave: Adds a waveform visual when supported.
media.mergeVideos, media.addAudioToVideos, media.turnImagesIntoVideos: Advanced media processing options.
options.makeLastSlideFillRecordingLength, options.preventSummarization: Fine-tune generation behavior.

Backward compatibility:

audio.* is accepted as alias of music.*.
options.durationSeconds / options.stylePrompt map to source.*.
options.generateMusic / options.generationMusicPrompt map to music.*.
options.generationPreset / media.generationPreset map to media.mediaPreset.

Validation:

URLs must be public http(s).
music.audioUrl is reachability-checked.
Invalid enum/range returns 400 with field-specific error.

\n","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"0511798d-6955-4d43-bffb-deef271ac49e"},{"name":"from Script To Video","id":"8657d900-100b-430f-aa80-432a2a2649c0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"script-to-video\",\n \"source\": {\n \"text\": \"this is my video text\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"quality\": \"pro\",\n \"density\": \"high\",\n \"animation\": \"soft\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"stability\": 0.2,\n \"speed\": 1\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"music\": {\n \"trackName\": \"Observer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"8657d900-100b-430f-aa80-432a2a2649c0"},{"name":"from Script with Custom Media","id":"c8659eac-349a-474e-a0b3-21d4a939016c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"script-to-video\",\n \"source\": {\n \"text\": \"this is a test\"\n },\n \"media\": {\n \"type\": \"custom\",\n \"density\": \"medium\",\n \"imageModel\": \"cheap\",\n \"videoModel\": \"base\",\n \"useOnlyProvided\": true,\n \"turnImagesIntoVideos\": true,\n \"provided\": [\n {\n \"url\": \"https://cdn.revid.ai/ai-gen/TAINdpjKn.jpg\",\n \"title\": \"An abstract, beautiful shot of three distinct beams of light merging into a single radiant golden source.\",\n \"type\": \"image\"\n },\n {\n \"url\": \"https://cdn.revid.ai/ai-gen/OZxUbirp4.jpg\",\n \"title\": \"Three women appear as silhouettes in front of a giant glowing sun in a dark indigo sky.\",\n \"type\": \"image\"\n },\n {\n \"url\": \"https://cdn.revid.ai/ai-gen/xA1PjFVGorg.jpg\",\n \"title\": \"A woman with a sleek black bob stands in a neon-lit glass hallway with rain outside.\",\n \"type\": \"image\"\n }\n ]\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"nPczCjzI2devNBz1zQrb\",\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"\",\n \"position\": \"bottom\"\n },\n \"metadata\": null,\n \"aspectRatio\": \"9 / 16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8659eac-349a-474e-a0b3-21d4a939016c"},{"name":"from Prompt To Video","id":"a41be02d-b9e6-43a0-b2a4-3f8f66cebe0f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"prompt-to-video\",\n \"source\": {\n \"prompt\": \"this is my prompt\",\n \"stylePrompt\": \"dark mood\",\n \"durationSeconds\": 40\n },\n \"media\": {\n \"type\": \"ai-video\",\n \"quality\": \"ultra\",\n \"density\": \"high\"\n },\n \"options\": {\n \"promptTargetDuration\": 30\n },\n \"characterIds\": [\n \"ac873ae7-aec1-4261-b8ef-bbd85547652e\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"a41be02d-b9e6-43a0-b2a4-3f8f66cebe0f"},{"name":"from Music To Video","id":"6056231d-451f-4612-ba5c-3a174d23c1d2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"music-to-video\",\n \"source\": {\n \"url\": \"https://www.youtube.com/watch?v=ip30oRP9BP0\",\n \"recordingType\": \"video\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"imageModel\": \"good\",\n \"videoModel\": \"ultra\"\n },\n \"voice\": {\n \"enabled\": false,\n \"voiceId\": \"nPczCjzI2devNBz1zQrb\",\n \"stability\": 0.2,\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"music\": {\n \"enabled\": false,\n \"soundWave\": true,\n \"syncWith\": \"lyrics\"\n },\n \"options\": {\n \"disableAudio\": true\n },\n \"metadata\": null,\n \"aspectRatio\": \"16 / 9\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"6056231d-451f-4612-ba5c-3a174d23c1d2"},{"name":"from Audio To Video","id":"70629255-9752-4e2d-9093-0faf374a9fd0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"audio-to-video\",\n \"source\": {\n \"url\": \"https://www.youtube.com/watch?v=ip30oRP9BP0\"\n },\n \"media\": {\n \"type\": \"ai-video\",\n \"density\": \"medium\",\n \"imageModel\": \"good\",\n \"videoModel\": \"ultra\",\n \"mediaPreset\": \"DEFAULT\",\n \"bRollType\": \"split-screen\"\n },\n \"voice\": {\n \"enabled\": false,\n \"voiceId\": \"nPczCjzI2devNBz1zQrb\",\n \"stability\": 0.2,\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\",\n \"autoCrop\": true\n },\n \"music\": {\n \"enabled\": false,\n \"trackName\": \"Observer\"\n },\n \"options\": {\n \"useWholeAudio\": true,\n \"hasToTranscript\": true,\n \"disableAudio\": true\n },\n \"metadata\": {\n \"lengthSeconds\": 1184,\n \"title\": \"Votre argent ne vous appartient pas | Éric Larchevêque\",\n \"urlType\": \"youtube\",\n \"url\": \"https://www.youtube.com/watch?v=ip30oRP9BP0\",\n \"duration\": 1184\n },\n \"aspectRatio\": \"16 / 9\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"70629255-9752-4e2d-9093-0faf374a9fd0"},{"name":"from Article To Video","id":"95d2f573-da59-4eba-86ea-d2d00df7afa7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"article-to-video\",\n \"source\": {\n \"url\": \"https://open.spotify.com/track/5Cp75TUMrHF6c8xbhdligS?si=215888ce8b784bc9\"\n },\n \"options\": {\n \"summarizationPreference\": \"summarize\",\n \"targetDuration\": 30\n },\n \"metadata\": {\n \"urlType\": \"spotify\",\n \"duration\": 194\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"95d2f573-da59-4eba-86ea-d2d00df7afa7"},{"name":"from Avatar To Video","id":"4ae88f4b-8606-4229-b13a-128c7ba10079","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"avatar-to-video\",\n \"source\": {\n \"text\": \"this is my text\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"bRollType\": \"split-screen\",\n \"placeAvatarInContext\": true\n },\n \"avatar\": {\n \"enabled\": true,\n \"url\": \"https://cdn.revid.ai/ai-gen/chSmd-WtE.jpg\",\n \"mimeType\": \"image/jpeg\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ae88f4b-8606-4229-b13a-128c7ba10079"},{"name":"from Static BG Video","id":"095cec93-7c1c-4c93-9b72-689c09758c0a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"static-background-video\",\n \"source\": {\n \"text\": \"this is my text\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"backgroundVideo\": {\n \"type\": \"video\",\n \"url\": \"https://cdn.revid.ai/backgrounds/minecraft/color-upscaled.mp4\",\n \"urlLowRes\": \"https://cdn.revid.ai/backgrounds/minecraft/color_low.mp4\",\n \"imagePreview\": \"https://cdn.revid.ai/backgrounds/minecraft/color_poster.webp\",\n \"noReencode\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"095cec93-7c1c-4c93-9b72-689c09758c0a"},{"name":"from Caption Video","id":"8324bbc8-92cb-4b13-acaf-c7651c7674f2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"caption-video\",\n \"source\": {\n \"url\": \"https://cdn.revid.ai/uploads/1771944925512-video.mp4\",\n \"recordingType\": \"video\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"bRollType\": \"split-screen\"\n },\n \"captions\": {\n \"enabled\": true,\n \"autoCrop\": true\n },\n \"metadata\": {\n \"duration\": 8.042667\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"8324bbc8-92cb-4b13-acaf-c7651c7674f2"},{"name":"from AI Ad Generator","id":"a8b406f5-4e25-4e5e-bb5d-5b31465188b9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"ad-generator\",\n \"source\": {\n \"prompt\": \"my ad prompt\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"quality\": \"ultra\",\n \"useOnlyProvided\": true,\n \"provided\": [\n {\n \"url\": \"https://cdn.revid.ai/uploads/1771944959344-image.png\",\n \"type\": \"image\",\n \"title\": \"\"\n }\n ]\n },\n \"options\": {\n \"promptTargetDuration\": 30\n },\n \"metadata\": {\n \"duration\": 8.042667\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"a8b406f5-4e25-4e5e-bb5d-5b31465188b9"},{"name":"from with Stock Video","id":"bdadb687-012b-4b30-a9e2-d89c4f8c9c54","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"script-to-video\",\n \"source\": {\n \"text\": \"this is my video text\"\n },\n \"media\": {\n \"type\": \"stock-video\",\n \"density\": \"high\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"stability\": 0.2,\n \"speed\": 1\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"music\": {\n \"trackName\": \"Observer\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdadb687-012b-4b30-a9e2-d89c4f8c9c54"},{"name":"from X/Linkedin To Video","id":"49ab9c39-e9a9-4ebe-b95a-0c2cd86669ec","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"script-to-video\",\n \"source\": {\n \"text\": \"https://x.com/tibo_maker/status/1848647301998284964\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"density\": \"medium\",\n \"animation\": \"dynamic\",\n \"imageModel\": \"good\",\n \"videoModel\": \"ultra\",\n \"mediaPreset\": \"DEFAULT\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"options\": {\n \"summarizationPreference\": \"summarize\"\n },\n \"metadata\": {},\n \"aspectRatio\": \"9 / 16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"49ab9c39-e9a9-4ebe-b95a-0c2cd86669ec"},{"name":"from Video Quiz","id":"2c374fc0-48a8-463c-9e32-c31a1a982214","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"script-to-video\",\n \"source\": {\n \"text\": \"https://x.com/tibo_maker/status/1848647301998284964\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"density\": \"medium\",\n \"animation\": \"dynamic\",\n \"imageModel\": \"good\",\n \"videoModel\": \"ultra\",\n \"mediaPreset\": \"DEFAULT\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"advanced\": {\n \"customCreationParams\": {\n \"quizzData\": {\n \"questions\": [\n {\n \"id\": \"82e14b8f-07ce-4489-9c35-6d9c10872b4e\",\n \"question\": \"What is France\",\n \"answers\": [\n {\n \"id\": \"a62c6e91-da4b-491a-8f36-ba67caa5838a\",\n \"answer\": \"a country\",\n \"isCorrect\": true\n },\n {\n \"id\": \"10c89812-22f8-47df-88ef-f11e318fdb1c\",\n \"answer\": \"a city\",\n \"isCorrect\": false\n }\n ]\n }\n ],\n \"title\": \"France\"\n }\n }\n },\n \"metadata\": null,\n \"aspectRatio\": \"9 / 16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c374fc0-48a8-463c-9e32-c31a1a982214"},{"name":"from PDF to Video","id":"cf30fe5b-5a3b-46e9-bd3b-8a6cc3820027","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"caption-video\",\n \"source\": {\n \"url\": \"https://cdn.revid.ai/uploads/1772035824673-application.pdf\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"density\": \"medium\",\n \"animation\": \"dynamic\",\n \"imageModel\": \"cheap\",\n \"videoModel\": \"base\",\n \"mediaPreset\": \"DEFAULT\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"nPczCjzI2devNBz1zQrb\",\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"\",\n \"position\": \"bottom\"\n },\n \"metadata\": {\n \"path\": \"2024-February-carousel-thibaultll.pdf\",\n \"mediaId\": \"f539cd4c-562e-49e7-810c-13cd2899563f\",\n \"url\": \"https://cdn.revid.ai/uploads/1772035824673-application.pdf\"\n },\n \"aspectRatio\": \"9 / 16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf30fe5b-5a3b-46e9-bd3b-8a6cc3820027"},{"name":"from Motion Transfer","id":"e704b103-2957-4128-9b93-d52f010f847d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"motion-transfer\",\n \"source\": {\n \"url\": \"https://cdn.revid.ai/uploads/1772035872439-video.mp4\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"density\": \"medium\",\n \"animation\": \"dynamic\",\n \"imageModel\": \"good\",\n \"videoModel\": \"ultra\",\n \"mediaPreset\": \"DEFAULT\",\n \"useOnlyProvided\": true,\n \"provided\": [\n {\n \"url\": \"https://cdn.revid.ai/uploads/1772035882827-image.jpg\",\n \"title\": \"\",\n \"type\": \"image\"\n }\n ]\n },\n \"voice\": {\n \"enabled\": false,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"metadata\": {\n \"duration\": 25.322667\n },\n \"aspectRatio\": \"9 / 16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"e704b103-2957-4128-9b93-d52f010f847d"},{"name":"from News to video","id":"09ccac55-a6e0-4789-8315-54ead972c1fa","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://your-server.com/revid/webhook\",\n \"workflow\": \"prompt-to-video\",\n \"source\": {\n \"prompt\": \"news about France\",\n \"durationSeconds\": 40\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"density\": \"medium\",\n \"animation\": \"dynamic\",\n \"imageModel\": \"good\",\n \"videoModel\": \"ultra\",\n \"mediaPreset\": \"DEFAULT\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\",\n \"speed\": 1,\n \"useLegacyModel\": false\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n },\n \"options\": {\n \"promptTargetDuration\": 30\n },\n \"advanced\": {\n \"customCreationParams\": {\n \"fetchNews\": true,\n \"promptCustomRules\": \"Use recent factual sources and structure as a professional news report.\"\n }\n },\n \"metadata\": null,\n \"aspectRatio\": \"9 / 16\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/render","urlObject":{"path":["api","public","v3","render"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"09ccac55-a6e0-4789-8315-54ead972c1fa"},{"name":"Get Projects","id":"b7375d4f-0604-4efa-91da-beba4399d77e","request":{"method":"GET","header":[{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"url":"https://www.revid.ai/api/public/v3/projects?limit=10","description":"

Get the status of a project. Use the pid retrieved at project creation.

\n","urlObject":{"path":["api","public","v3","projects"],"host":["https://www.revid.ai"],"query":[{"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"b7375d4f-0604-4efa-91da-beba4399d77e"},{"name":"Get Video Status","id":"c5c16e0e-1f4b-4f1b-9b06-b21f23dabe91","request":{"method":"GET","header":[{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"url":"https://www.revid.ai/api/public/v3/status?pid=REPLACE_WITH_PROJECT_ID","description":"

Get the status of a project. Use the pid retrieved at project creation.

\n","urlObject":{"path":["api","public","v3","status"],"host":["https://www.revid.ai"],"query":[{"key":"pid","value":"REPLACE_WITH_PROJECT_ID"}],"variable":[]}},"response":[],"_postman_id":"c5c16e0e-1f4b-4f1b-9b06-b21f23dabe91"},{"name":"Estimate Credits","id":"4dc6c2f3-f25a-44d9-b686-d6d601fa52ca","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"workflow\": \"script-to-video\",\n \"source\": {\n \"text\": \"this is a test\"\n },\n \"media\": {\n \"type\": \"moving-image\",\n \"quality\": \"pro\",\n \"density\": \"high\",\n \"animation\": \"soft\"\n },\n \"voice\": {\n \"enabled\": true,\n \"voiceId\": \"cgSgspJ2msm6clMCkdW9\"\n },\n \"captions\": {\n \"enabled\": true,\n \"preset\": \"Wrap 1\",\n \"position\": \"bottom\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/calculate-credits","description":"

Estimate credits for a generation payload using the same v3 schema as POST /api/public/v3/render.

You can send either:

v3 format (workflow, source, media, voice, ...)
legacy format (creationParams) for backward compatibility.

\n","urlObject":{"path":["api","public","v3","calculate-credits"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"4dc6c2f3-f25a-44d9-b686-d6d601fa52ca"},{"name":"Add To Queue","id":"fc37583b-6650-4a71-a237-ff51cf2cdebf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"videoUrl\": \"https://cdn.revid.ai/uploads/your-video.mp4\",\n \"channelName\": \"Main Channel\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/add-to-queue","description":"

Add a content to your Revid scheduling queue, it will be scheduled at the next available queue slot.

Use either channelName (name of a channel you add in your Account Settings) or one or multiple social account.

To specify social media account, use the username as specified in your Revid account settings.

\n","urlObject":{"path":["api","public","v3","add-to-queue"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc37583b-6650-4a71-a237-ff51cf2cdebf"},{"name":"Publish Now","id":"acdd4c0d-5697-4d77-81fc-2dc8a65fa589","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"videoUrl\": \"https://cdn.revid.ai/uploads/your-video.mp4\",\n \"channelName\": \"Main Channel\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/publish-now","description":"

Publish a video now.

Use either channelName (name of a channel you add in your Account Settings) or one or multiple social account.

To specify social media account, use the username as specified in your Revid account settings.

\n","urlObject":{"path":["api","public","v3","publish-now"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"acdd4c0d-5697-4d77-81fc-2dc8a65fa589"},{"name":"Export Project","id":"b28ad063-bf86-438b-97c4-0f897fe57424","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pid\": \"REPLACE_WITH_PROJECT_ID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/export-video","description":"

Export the project and return a video file.
Requires a valid project ID that you own as input.
Rendering a project costs 10 credits.

\n","urlObject":{"path":["api","public","v3","export-video"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"b28ad063-bf86-438b-97c4-0f897fe57424"},{"name":"Rename Project","id":"b0056cef-3b70-40a1-98d9-1b7f1b84fcec","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pid\": \"REPLACE_WITH_PROJECT_ID\",\n \"name\": \"My New Project Name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/rename-project","description":"

Renames a project owned by the API key user.

\n","urlObject":{"path":["api","public","v3","rename-project"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0056cef-3b70-40a1-98d9-1b7f1b84fcec"},{"name":"Get All Consistent Characters","id":"0b52667d-5bd9-4851-8b3b-d65d1220b0f8","request":{"method":"GET","header":[{"key":"key","value":"YOUR_REVID_API_KEY","description":"

Your Revid API key (required). Found in your account settings.

\n","type":"text"}],"url":"https://www.revid.ai/api/public/v3/consistent-characters","description":"

Retrieve all consistent characters for the authenticated user.

Returns characters from two sources:

Avatar-based characters — saved via the UI or API, stored with a name and description
LoRA-trained characters — trained custom character models with status \"ready\"

Results are sorted by createdAt descending (newest first).

Response fields per character

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	string	Unique character ID (use this for deletion)
`name`	string	Character name
`description`	string	Character description (used by AI to understand context)
`imageUrl`	string	URL of the character image
`contentType`	string	Media type — `image/png`, `video/mp4`, or `character` (for LoRA)
`source`	string	Origin — `avatar` or `lora`
`createdAt`	number	Unix timestamp in milliseconds

","urlObject":{"path":["api","public","v3","consistent-characters"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b52667d-5bd9-4851-8b3b-d65d1220b0f8"},{"name":"Create Consistent Character","id":"69236992-c9cb-4b31-ad26-360b1049b870","request":{"method":"POST","header":[{"key":"key","value":"YOUR_REVID_API_KEY","description":"

Your Revid API key (required). Found in your account settings.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sarah\",\n \"description\": \"A friendly teacher who explains complex topics simply\",\n \"imageUrl\": \"https://cdn.revid.ai/ai-gen/chSmd-WtE.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/consistent-characters","description":"

Create a new consistent character.

The character is saved as an avatar with a description, making it available both as a consistent character in stories/videos and as a talking avatar in video creation tools.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	Yes	Character name (min 3 characters)
`description`	string	Yes	Character description (min 10 characters). This is used by the AI to understand when and how to use this character.
`imageUrl`	string	Yes	A valid URL pointing to the character image

Validation rules

name must be at least 3 characters
description must be at least 10 characters
imageUrl must be a valid, well-formed URL

\n","urlObject":{"path":["api","public","v3","consistent-characters"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"69236992-c9cb-4b31-ad26-360b1049b870"},{"name":"Delete Consistent Character","id":"0eb116be-f140-4ccd-bd39-287f8aa46faa","request":{"method":"DELETE","header":[{"key":"key","value":"YOUR_REVID_API_KEY","description":"

Your Revid API key (required). Found in your account settings.

\n","type":"text"}],"url":"https://www.revid.ai/api/public/v3/consistent-characters?id=REPLACE_WITH_CHARACTER_ID","description":"

Delete a consistent character by its ID.

The endpoint looks up the character in both the avatars collection and the LoRA collection, so it works for both types of characters.

Parameters

The id can be passed either as:

A query parameter: ?id=xxx
Or in the request body: { \"id\": \"xxx\" }

Get the character id from the GET endpoint response.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`success`	number	`1` on success, `0` on failure
`deleted`	string	The ID of the deleted character
`source`	string	Which collection it was deleted from — `avatar` or `lora`

","urlObject":{"path":["api","public","v3","consistent-characters"],"host":["https://www.revid.ai"],"query":[{"key":"id","value":"REPLACE_WITH_CHARACTER_ID"}],"variable":[]}},"response":[],"_postman_id":"0eb116be-f140-4ccd-bd39-287f8aa46faa"},{"name":"Buy Credit Pack","id":"5dfc5619-3aa3-4294-9178-7c03980bfca2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"key","value":"YOUR_REVID_API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\n \"source\": \"auto_topup\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/buy-credit-pack","description":"

API endpoint to trigger auto top-up credit pack purchase.

Required body field:

source: must be auto_topup.

This endpoint charges the saved payment method and returns invoice metadata.

\n","urlObject":{"path":["api","public","v3","buy-credit-pack"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"5dfc5619-3aa3-4294-9178-7c03980bfca2"},{"name":"Clone Voice","id":"2f997ffe-fd13-47d9-a1bc-2369873563ce","request":{"method":"POST","header":[{"key":"key","value":"YOUR_REVID_API_KEY","description":"

Your Revid API key (required). Found in your account settings.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Voice\",\n \"description\": \"A friendly voice for tutorials\",\n \"voiceUrl\": \"https://cdn.revid.ai/uploads/sample-voice.mp3\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.revid.ai/api/public/v3/voice-clone","description":"

Clone a voice from an audio sample.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	Yes	Voice name (min 3 characters)
`description`	string	No	Voice description
`voiceUrl`	string	Yes	A valid URL pointing to the audio sample (mp3, wav, etc.)

Validation rules

name must be at least 3 characters
voiceUrl must be a valid, well-formed URL
User must be on Elite plan or above

\n","urlObject":{"path":["api","public","v3","voice-clone"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f997ffe-fd13-47d9-a1bc-2369873563ce"}],"variable":[{"key":"baseUrl","value":"https://www.revid.ai"},{"key":"apiKey","value":"YOUR_REVID_API_KEY"},{"key":"webhookUrl","value":"https://your-server.com/revid/webhook"},{"key":"spotifyTrackUrl","value":"https://open.spotify.com/track/5Cp75TUMrHF6c8xbhdligS?si=215888ce8b784bc9"},{"key":"sourceUrl","value":"https://cdn.revid.ai/uploads/1771944925512-video.mp4"},{"key":"audioToVideoSourceUrl","value":"https://www.youtube.com/watch?v=ip30oRP9BP0"},{"key":"avatarUrl","value":"https://cdn.revid.ai/ai-gen/chSmd-WtE.jpg"},{"key":"backgroundVideoUrl","value":"https://cdn.revid.ai/backgrounds/minecraft/color-upscaled.mp4"},{"key":"productImageUrl","value":"https://cdn.revid.ai/uploads/1771944959344-image.png"},{"key":"projectId","value":"REPLACE_WITH_PROJECT_ID"},{"key":"videoUrl","value":"https://cdn.revid.ai/uploads/your-video.mp4"},{"key":"channelName","value":"Main Channel"},{"key":"characterId","value":"REPLACE_WITH_CHARACTER_ID"}]}