CartViral API
Last updated: 3 November 2026
Authorization: Bearer cv_live_...) or an OAuth 2.1 access token. The same operations are available to AI agents through the MCP server, and the full spec is at /api/v1/openapi.json (OpenAPI 3.1).Endpoints
Every operation in the OpenAPI spec, the same set the MCP server offers. Base URL https://app.cartviral.com/api/v1.
| Method and path | What it does | Credits |
|---|---|---|
| GET /account | Plan, credit balance and clip prices | 0 |
| POST /products/import | Import products from a store or product URL | 0 |
| GET /products | Catalog products with their CartViral score | 0 |
| GET /products/{product_id}/listing-copy | Marketplace listing copy and SEO/GEO for a product (1 credit the first time, free when cached) | 1 the first time, then free |
| GET /products/{product_id}/copy/{tool} | Ad copy, social captions, a creator brief or a 30-day content plan for a product (1 credit the first time per tool, free when cached) | 1 per tool the first time, then free |
| POST /clips | Queue clips of a product | 1 / 6 / 12 per clip |
| GET /clips | Clips with render status and download links | 0 |
| POST /clips/remake | Remake a reference video with your product | 6 |
| POST /photos | Queue an AI photo set of a product | 9 / 8 / 7 per set |
| GET /photos | Photo sets with render status and download links | 0 |
| POST /carousels | Queue a carousel of a product | 3 per set |
| GET /carousels | Carousels with render status and download links | 0 |
| POST /static-ads | Queue a static ad image set of a product | 4 per set |
| GET /static-ads | Static ad sets with render status and download links | 0 |
| GET /offers | Creator marketplace offers | 0 |
| POST /offers/{offer_id}/join | Join an offer and get a tracking link | 0 |
| POST /pitches | Pitch a brand: 3 AI clips and a page to send | 18 |
| GET /pitches | Your pitches and who opened them | 0 |
| GET /create/options | Create: video models, frames, camera moves and prices | 0 |
| POST /media | Store an image or video from a public link or base64 | 0 |
| POST /create/image | Images from your own prompt and reference photos (covers, banners, scenes) | 1 per image |
| POST /create/video | A short video from a prompt, with camera moves and models | 2 on our engine |
| POST /create/angles | New angles of one photo | 1 per angle |
| POST /create/talking-photo | A photo says your text on camera | 2 per 10 s take |
| POST /create/cinematic | A 15 or 30 s brand film of a product | 12 / 18 |
| POST /create/reframe | Change a video's frame (9:16, 4:5, 1:1, 16:9) | 1 |
| POST /create/remove-background | Cut-out PNG and white-background JPG | 1 |
| POST /create/motion | A character repeats a reference video's movement | Premium, by length |
| POST /create/breakdown | Why a viral video works: hook, beats, timings (free) | 0 |
| GET /creations | Create jobs with status and result links | 0 |
| GET /creations/{job_id} | One Create job with its result links | 0 |
| POST /characters | Two portraits of a new brand character | 2 |
| GET /characters | The brand's saved characters | 0 |
| POST /characters/save | Keep a portrait as a brand character | 0 |
Quick start
curl https://app.cartviral.com/api/v1/account \
-H "Authorization: Bearer $CARTVIRAL_API_KEY"
curl -X POST https://app.cartviral.com/api/v1/products/import \
-H "Authorization: Bearer $CARTVIRAL_API_KEY" -H "Content-Type: application/json" \
-d '{"url": "https://yourstore.com/products/your-product"}'
curl -X POST https://app.cartviral.com/api/v1/clips \
-H "Authorization: Bearer $CARTVIRAL_API_KEY" -H "Content-Type: application/json" \
-d '{"product_id": "PRODUCT_ID", "clip_type": "ai_story", "count": 2}'
curl "https://app.cartviral.com/api/v1/clips?status=done" \
-H "Authorization: Bearer $CARTVIRAL_API_KEY"
Authentication
- API key: create one at Account → AI agents. Send it as
Authorization: Bearer cv_live_...orx-api-key: cv_live_.... Keys act as your account (same credits and limits) and can be revoked on the same page. - OAuth 2.1: authorization code flow. Authorize at
/oauth/authorize, exchange at/oauth/token, scopemcp. Public clients use PKCE (S256); confidential clients authenticate with their secret. Clients can self-register at/oauth/register(RFC 7591); discovery at/.well-known/oauth-authorization-server.
Errors and limits
- Errors return a JSON body
{"error": "..."}with 400 (invalid input or the action can't be done), 401 (credentials), 404 (unknown endpoint) or 429 (rate limit). - 120 calls per minute per key. AI clips take 10-15 minutes: poll
GET /clipsevery minute or two. - A clip that fails to render refunds its credits automatically.
Automations
Use the API from any HTTP step (Zapier Webhooks, Make HTTP, n8n HTTP Request) or connect an AI agent through MCP: see n8n and Make and MCP for AI agents.
FAQ
Does CartViral have an API?
Yes: a REST API at https://app.cartviral.com/api/v1 with an OpenAPI 3.1 spec at /api/v1/openapi.json, plus an MCP server for AI agents.
How do I get an API key?
Create a free account, then Account → AI agents → Create an API key. It's shown once; revoke it anytime.
Does the API cost extra?
No. Reading data is free; clips are paid from your account's credits: 1 for a montage, 6 for an AI story reel, 12 for a creator (UGC) clip.
Can I use OAuth instead of a key?
Yes. The authorization code flow with PKCE is supported, and clients can register themselves.
Free account, 18 free credits, no card.
Open AI agentsMore guides: Best AI product video generators · Creatify alternatives · Topview alternatives · Revid alternatives · Content Rewards alternative · Trybe alternatives · Product link to TikTok video · Earn with AI product videos · MCP for AI agents · n8n and Make · Shopify Collabs alternative · Start a Shopify affiliate program · AI video affiliate programs · Faceless affiliate with AI videos · Clipping jobs: per view vs per sale · Arcads pricing · Creatify pricing · Creatify vs Arcads · Higgsfield alternatives · Product videos from photos · Etsy listing videos · Shopify product page video · TikTok Shop product videos · TikTok Shop affiliate without followers · Get paid to post product videos · How to find clipping jobs