Revid MCP for AI agents is available at POST https://www.revid.ai/api/mcp.\nUse it when you want Cursor, Claude, ChatGPT, or custom agents to call Revid tools directly. Authenticate with Authorization: Bearer YOUR_REVID_API_KEY, x-revid-api-key, x-api-key, or key. Human and agent guide: https://www.revid.ai/mcp
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:
\nGet API codeRelated docs:
\nPOST https://www.revid.ai/api/mcpGET https://www.revid.ai/api/public/v3/renderhttps://www.revid.ai/postman/revid-public-v3-render.openapi.jsonCanonical shape:
\n{\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}\nKey rules:
\nmedia.generateVideos is removed and auto-derived.media.animation applies only for media.type = moving-image.media.hasEnhancedGeneration* are derived from media.imageModel.source: source.stylePrompt, source.durationSeconds.music: music.generateMusic, music.generationMusicPrompt.audio-to-video, options.useWholeAudio defaults to true.options.outputCount when 1).Workflow requirements:
\nscript-to-video: source.textaudio-to-video: source.urlavatar-to-video: source.text + avatar.urlprompt-to-video: source.promptad-generator: source.prompt or media.provided[]music-to-video: source.urlarticle-to-video: source.urlmotion-transfer: source.url + media.provided[]caption-video: source.urlstatic-background-video: source.text or source.urlCore enums:
\nmedia.type: moving-image, ai-video, video, stock-video, custommedia.animation: none, soft, dynamic, depthcaptions.position: top, middle, bottommusic.syncWith: beats, lyricsAdditional Parameters (New in v3):
\nmusic.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:
\naudio.* 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:
\nhttp(s).music.audioUrl is reachability-checked.400 with field-specific error.Get the authenticated user's email, total credits, subscription status, and workspace context.
\n","urlObject":{"path":["api","public","v3","me"],"host":["https://www.revid.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"29c2e617-a298-4035-afdd-d7be10d3986f"},{"name":"Get Projects","id":"999fb0c3-b772-4679-bdd2-4b6df63d36db","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":"999fb0c3-b772-4679-bdd2-4b6df63d36db"},{"name":"Get Video Status","id":"5ed065dc-9996-473b-87bb-57964830a2ac","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":"5ed065dc-9996-473b-87bb-57964830a2ac"},{"name":"Estimate Credits","id":"bf365e7e-0ccd-4d02-8e3d-517da7e56c2b","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:
\nworkflow, source, media, voice, ...)creationParams) for backward compatibility.Add a content to your Revid scheduling queue, it will be scheduled at the next available queue slot.
\nUse 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":"a9d24d1c-3011-4eca-94d0-a202fd89d226"},{"name":"Publish Now","id":"74de4e0b-056a-4d0e-ad98-93ca1fa59a31","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.
\nUse 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":"74de4e0b-056a-4d0e-ad98-93ca1fa59a31"},{"name":"Export Project","id":"e03a2269-62c3-44df-b85a-fee5ac7ea377","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.
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":"c2ad3634-9205-4f23-a111-7cd13c31bbc1"},{"name":"Get All Consistent Characters","id":"2bac5d8c-26de-4ef8-a2ff-f392e3e9ce49","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.
\nReturns characters from two sources:
\nResults are sorted by createdAt descending (newest first).
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.
\nThe 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.
\nname must be at least 3 charactersdescription must be at least 10 charactersimageUrl must be a valid, well-formed URLYour 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.
\nThe endpoint looks up the character in both the avatars collection and the LoRA collection, so it works for both types of characters.
\nThe id can be passed either as:
?id=xxx{ \"id\": \"xxx\" }Get the character id from the GET endpoint response.
API endpoint to trigger auto top-up credit pack purchase.
\nRequired body field:
\nsource: 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":"36ab6e97-8666-450f-92f2-d6175ba6b632"},{"name":"Clone Voice","id":"9edcd6ce-484d-4e0f-b630-d8c8d75b3645","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.
\nname must be at least 3 charactersvoiceUrl must be a valid, well-formed URL