Skip to content

6missedcalls/revid-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

revid-skill

Automate video creation, publishing, and media workflows from your terminal.

License: MIT Shell: Bash Endpoints: 14 Made for: Claude Code

A Claude Code skill that wraps the Revid API V2 into a single Bash script — render videos, publish to TikTok/YouTube/Instagram, manage media, and handle consistent characters, all without leaving your terminal.


Highlights

  • One script, 13 commands — every Revid V2 endpoint accessible via revid_api.sh
  • Zero dependencies — pure Bash + curl; no runtimes, no package managers
  • Claude Code native — skill metadata (SKILL.md) lets Claude invoke endpoints automatically
  • Publish anywhere — TikTok, YouTube Shorts, Instagram Reels in a single API call
  • Full media pipeline — render, estimate credits, export, search stock/AI media, manage characters

Table of Contents


What Is This?

revid-skill is a Claude Code skill — a self-contained package that teaches Claude how to interact with the Revid video creation platform.

It includes:

File Purpose
SKILL.md Skill trigger description and usage instructions for Claude Code
scripts/revid_api.sh Bash wrapper around all 14 Revid API V2 endpoints
references/revid-api-reference.md Bundled API reference with request schemas and examples
agents/openai.yaml UI metadata for Codex app surfaces

When Claude encounters a task involving Revid — rendering videos, checking project status, publishing to social media — it reads the skill metadata and uses the bundled script and reference docs to execute the workflow.


Prerequisites

  • Bash (4.0+) and curl
  • A Revid API key (get one here)
  • Claude Code (optional — the script works standalone too)

Quick Start

1. Export your API key

export REVID_API_KEY="your_api_key_here"

2. Run a command

bash scripts/revid_api.sh projects 10

3. Render a video

bash scripts/revid_api.sh render payload.json

That's it. No install step, no build process.


Commands Reference

Command Arguments Description
render <payload.json> Create and render a video from a JSON payload
estimate <payload.json> Estimate credit cost before rendering
export <pid> Export a rendered project as a video file
status <pid> Check the render status of a project
projects [limit] List your projects (default: 10)
rename <pid> <new-name> Rename an existing project
queue <payload.json> Add a video to your publishing queue
publish <payload.json> Publish a video immediately
media [mediaType] [topK] [after] Browse your media library
media-search <query> [mediaType] [topK] Search media by natural language
characters-list List all consistent characters
characters-create <payload.json> Create a new consistent character
characters-delete <character-id> Delete a consistent character

API Endpoints Covered

# Endpoint Method Path
1 Create TikTok Video POST /api/public/v2/render
2 Export Project POST /api/public/v2/export-video
3 Estimate Credits POST /api/public/v2/calculate-credits
4 Get Video Status GET /api/public/v2/status
5 Get Projects GET /api/public/v2/projects
6 Add To Queue POST /api/public/v2/add-to-queue
7 Publish Now POST /api/public/v2/publish-now
8 Get Media GET /api/public/media-search
9 Search Media GET /api/public/media-search
10 Rename Project POST /api/public/v2/rename-project
11 Get All Characters GET /api/public/v2/consistent-characters
12 Create Character POST /api/public/v2/consistent-characters
13 Delete Character DELETE /api/public/v2/consistent-characters

Full request/response schemas are in references/revid-api-reference.md.


Payload Examples

Render a video
{
  "webhook": "https://example.com/revid-webhook",
  "creationParams": {
    "inputText": "5 facts about the ocean that will blow your mind",
    "hasToGenerateVoice": true,
    "hasToSearchMedia": true,
    "mediaType": "movingImage",
    "generationPreset": "REALISM",
    "captionPresetName": "Wrap 1",
    "selectedVoice": "SAz9YHcvj6GT2YYXdXww"
  }
}
bash scripts/revid_api.sh render render.json
Estimate credits
{
  "creationParams": {
    "inputText": "A short script about productivity tips.",
    "hasToGenerateVoice": true,
    "hasToSearchMedia": true,
    "mediaType": "stockVideo"
  }
}
bash scripts/revid_api.sh estimate estimate.json
Publish to multiple platforms
{
  "videoUrl": "https://cdn.tfrv.xyz/renders/your-project/video.mp4",
  "channelName": "MyChannel",
  "tiktok": {
    "title": "Ocean Facts You Didn't Know",
    "privacy_level": "PUBLIC_TO_EVERYONE"
  },
  "youtube": {
    "title": "Ocean Facts You Didn't Know",
    "description": "5 incredible facts about the ocean."
  },
  "instagram": {
    "title": "Ocean Facts You Didn't Know"
  }
}
bash scripts/revid_api.sh publish publish.json
Create a consistent character
{
  "name": "Sarah",
  "description": "A friendly teacher who explains complex topics simply",
  "imageUrl": "https://cdn.example.com/characters/sarah.png"
}
bash scripts/revid_api.sh characters-create character.json

Video Creation Options

Media Types
Value Description
stockVideo Find and use stock video footage
movingImage Generate AI images and animate them
aiVideo Generate AI videos with state-of-the-art models
Generation Presets

LEONARDO · ANIME · REALISM · ILLUSTRATION · SKETCH_COLOR · SKETCH_BW · PIXAR · INK · RENDER_3D · LEGO · SCIFI · RECRO_CARTOON · PIXEL_ART · CREATIVE · PHOTOGRAPHY · RAYTRACED · ENVIRONMENT · FANTASY · ANIME_SR · MOVIE · STYLIZED_ILLUSTRATION · MANGA

Caption Presets
Preset Style
Basic Simple subtitles
Revid Revid branded style
Hormozi Alex Hormozi style captions
Ali Ali Abdaal style captions
Wrap 1 Word-wrap style (default)
Wrap 2 Alternate word-wrap style
Faceless Optimized for faceless content
Render Settings
Parameter Default Options
resolution 1080p 720p (faster), 1080p
compression 18 9 (low), 18 (medium), 33 (high)
frameRate 30 30, 60

Configuration

Environment Variable Required Default Description
REVID_API_KEY Yes Your Revid API key
REVID_BASE_URL No https://www.revid.ai Override the API base URL

Troubleshooting

"Set REVID_API_KEY before running this script"

Export your API key before running any command:

export REVID_API_KEY="your_api_key_here"
API returns unauthorized / user not found
  • Confirm the key value is correct
  • Confirm the key belongs to the intended Revid account
  • Confirm required plan/credits are available for the endpoint
Invalid JSON payload

Validate your payload before sending:

jq . your-payload.json

Ensure the file contains valid JSON with no comments or trailing commas.

Command not recognized

Run the script with no arguments to see all available commands:

bash scripts/revid_api.sh

Project Structure

revid-skill/
├── SKILL.md                              # Skill metadata for Claude Code
├── README.md                             # This file
├── LICENSE                               # MIT License
├── agents/
│   └── openai.yaml                       # Codex UI metadata
├── references/
│   └── revid-api-reference.md            # Bundled API reference (14 endpoints)
└── scripts/
    └── revid_api.sh                      # Bash API wrapper

Use Cases

Content creators — Generate short-form videos from text scripts and publish directly to TikTok, YouTube Shorts, and Instagram Reels.

Automation pipelines — Chain video creation into CI/CD or cron workflows. Estimate costs first, render, then auto-publish on a schedule.

AI agents — Let Claude Code handle the entire video workflow: write a script, render the video, check status, and publish — all through natural language.

Rapid prototyping — Test different generation presets, voices, and media types without building a custom integration.


License

MIT

Releases

No releases published

Packages

 
 
 

Contributors

Languages