YumCut API automation

YumCut video and prank image API

Create an API key once, then automate YumCut video creation, AI character videos, prank image generation, catalog previews, project status polling, and final media download URLs through the YumCut User API.

Create API key Open interactive docs

Bearer keys: read/write
Credit checks: built in
Final media: URLs

User API

automated

YumCut API generated vertical video preview

curl https://app.yumcut.com/api/user/v1/projects \
  -H "Authorization: Bearer $YUMCUT_API_KEY" \
  -H "Idempotency-Key: video-job-2026-07-08-001" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A 30 second product teaser for a mobile app launch",
    "projectExperience": "story",
    "durationSeconds": 30,
    "languages": ["en"],
    "captionsEnabled": true
  }'

Automation flow

Fully automated after API key creation

The API reuses the same user account, token balance, credit system, catalog data, and project engine as the web app, so automation does not bypass billing or duplicate project logic.

01
Create an API key
Generate a YumCut user API key and choose read, write, or both scopes.
02
Submit video or prank image jobs
Create projects from prompts, catalog characters, templates, or Image Prank source images.
03
Poll project status
Track each owned project until it is complete, stopped, failed, or ready for review.
04
Retrieve final URLs
Download final video, image, voiceover, and reusable Image Prank source data from API responses.

What you can automate

API methods for videos, Image Pranks, characters, settings, and downloads

OpenAPI schema

Automated video creation API

Create short video projects from prompts, scripts, languages, voices, templates, and project settings.

Prank image automation

Build Image Prank workflows with catalog image info, preview URLs, source image URLs, and final image download URLs.

Character catalog access

Read public character profiles, preview image URLs, preview video URLs, voice defaults, and variation preview images.

Account and token data

Check account profile, language, token balance, token history, project-cost quotes, and credit usage before creation.

Project lifecycle control

List only the authenticated user projects, get details, stop active work, cancel projects, and poll status safely.

Settings automation

Update user settings such as defaults for captions, music, overlays, watermarks, languages, voices, and approvals.

Endpoint map

Start with the high-value API calls

Use the interactive documentation for request bodies and live testing. These endpoint groups cover the common automation path for AI video API and prank image API workflows.

Projects

POST /api/user/v1/project-cost
POST /api/user/v1/projects
GET /api/user/v1/projects/{projectId}/status
GET /api/user/v1/projects/{projectId}/downloads/video
GET /api/user/v1/projects/{projectId}/downloads/image

Catalogs

GET /api/user/v1/templates
GET /api/user/v1/image-pranks
GET /api/user/v1/image-pranks/{slug}
GET /api/user/v1/characters/catalog
GET /api/user/v1/characters/{slug}

Account

GET /api/user/v1/account
GET /api/user/v1/tokens
GET /api/user/v1/tokens/history
GET /api/user/v1/settings
PATCH /api/user/v1/settings

Production use cases

Build video and prank image automation into your own workflow

Generate daily YouTube Shorts, TikTok, Instagram Reels, and LinkedIn vertical video from a content calendar.

Create prank image variations from catalog source images and user-provided placement photos.

Embed AI video generation into an internal CMS, creator dashboard, or agency production pipeline.

Preload catalog characters, story templates, and Image Prank previews before users submit a job.

Open the docs, enter your key, and test the API in the browser

The YumCut documentation is interactive: create a user API key, paste it into the docs authorization field, and run video creation or Image Prank catalog requests directly.

View API documentation Manage API keys