Skip to content
API Reference/
/
Get project export status

Shuffll API (1.2.0)

The Shuffll API enables seamless automation and integration of Shuffll's AI-powered video creation platform into external workflows.

What is Shuffll?

Shuffll is an AI-powered platform designed to automate and streamline video content creation for businesses, marketers, and content creators. By leveraging machine learning, Shuffll enables users to generate high-quality videos efficiently, reducing production time and effort while maintaining creative control.

With Shuffll's API, developers can integrate automated video generation into their applications, enabling seamless video content production at scale. Whether it's for marketing, social media, training, or corporate communications, Shuffll simplifies the process of creating engaging and professional videos.

Key Features

  • AI-Driven Video Creation – Generate videos automatically based on structured input, scripts, or templates.
  • Smart Editing & Automation – Apply transitions, overlays, and effects without manual editing.
  • Custom API Endpoints – Programmatically generate, edit, and manage video content.
  • Brand Consistency – Ensure that videos align with predefined brand styles and messaging.
  • Seamless Integrations – Connect with third-party tools, media libraries, and content management systems.

Shuffll's API empowers developers to automate video production, integrate AI-enhanced video workflows, and create personalized video content at scale—all with minimal effort.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://shuffll.com
E-mail
info@shuffll.com
License
MIT
Terms of Service
Languages
Servers
Mock server
https://api-docs.shuffll.com/_mock/apis
https://api.shuffll.com/api/v1

Configuration

Retrieve available options for AI voices, avatars, background music, and video category tags. Call these endpoints to populate field values when creating a project.

Operations

Organizations

Manage organizations and retrieve their workspaces, branding, and settings.

Operations

Workspaces

Manage workspaces within an organization, and list projects within a workspace.

Operations

Branding

Read and update branding configuration (logo, colors, company info, pronunciations) for a workspace or organization.

Operations

Assets

Upload, organize, rename, move, and delete media assets in a workspace. Assets can be referenced directly in project creation requests.

Operations

Templates

Browse and retrieve reusable video templates. Templates define the scene structure and visual style of a project.

Operations

Projects

Create, monitor, and manage AI-generated video projects.

Operations

Enhance

Monitor the automatic post-production enhancement process (branding, subtitles, audio cleanup) that runs after a project is created.

Operations

Export

Trigger video export and retrieve the final downloadable video URLs.

Operations

Export project

Request

Trigger the export of a completed project to a video file.

Returns a projectId and editId that can be used to poll the export status.

Prerequisites: The project must have completed enhancement before exporting. Check enhancement status with GET /auth/project/{projectId}/edit/status/enhance.

Security
ShuffllApiKey
Path
projectIdstring(uuid)required

Unique identifier for the project

Example: dad4bce8-f5cb-4078-a211-995864315e39
curl -i -X POST \
  https://api-docs.shuffll.com/_mock/apis/auth/project/dad4bce8-f5cb-4078-a211-995864315e39/edit/export \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Export job started successfully.

Bodyapplication/json
projectIdstring

Unique identifier of the project being exported

Example: "3be6453c-03eb-4357-ae5a-984a0e574a54"
editIdstring

Unique identifier of the edit created for this export job

Example: "2f14374a-9c65-4ee5-94b7-fba66d893483"
Response
application/json
{
  "projectId": "3be6453c-03eb-4357-ae5a-984a0e574a54",
  "editId": "2f14374a-9c65-4ee5-94b7-fba66d893483"
}

Get project export status

Request

Check the progress of a project export job.

  • A 202 response means the export is still being processed — continue polling.
  • A 200 response with isDone: true means the export is complete. The urls object will contain the video file URLs.

URLs returned on completion:

  • uploadPath — direct MP4 download URL
  • dashPath — MPEG-DASH streaming manifest URL
Security
ShuffllApiKey
Path
projectIdstring(uuid)required

Unique identifier for the project

Example: dad4bce8-f5cb-4078-a211-995864315e39
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/project/dad4bce8-f5cb-4078-a211-995864315e39/edit/status/export \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Export complete.

Bodyapplication/json
isDoneboolean(isDone)

Whether the operation is complete

urlsobject(Urls)

Video output URLs

Response
application/json
{
  "isDone": true,
  "urls": {
    "uploadPath": "https://content.shuffll.com/exports/project.mp4",
    "dashPath": "https://content.shuffll.com/exports/project.mpd"
  }
}