Skip to content
API Reference/
/
Upload asset

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

List assets

Request

Retrieve all assets in a workspace.

Use the type query parameter to filter by asset type (e.g., image, video, audio). Use the folder query parameter to list assets within a specific folder path.

The uploadPath field on each asset is the CDN URL you can use directly in videosToAdd[].url when creating a project.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
Query
typestring

Filter assets by type prefix (e.g., image, video, audio)

Enum"image""video""audio""pdf"
Example: type=video
folderstring

Filter assets by folder path (e.g., /my-folder)

Example: folder=/
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/apis/auth/workspace/693fb82afd8d1c43077ba0fe/assets?type=video&folder=%2F' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved assets.

Bodyapplication/jsonArray [
_idstring

Unique asset identifier

Example: "6947b539cc95ea68854bb523"
displayNamestring

Display name of the asset

Example: "product-demo.mp4"
uploadPathstring

CDN URL of the asset file. Use this value as videosToAdd[].url when creating a project.

Example: "https://content.shuffll.com/workspace/product-demo.mp4"
dashPathstring

MPEG-DASH streaming URL (available for video assets after processing)

Example: "https://content.shuffll.com/workspace/product-demo.mpd"
mimetypestring

MIME type of the file

Example: "video/mp4"
typestring

Asset category, automatically determined from MIME type

Enum"image""video""audio""pdf""folder"
Example: "video"
folderstring

Folder path the asset belongs to

Example: "/"
userEmailstring(email)

Email of the user who uploaded the asset

Example: "user@example.com"
createdAtstring(date-time)

Upload timestamp

Example: "2025-12-15T07:26:34.333Z"
aspectRatiostring

Aspect ratio of the asset (for images and videos)

Example: "16:9"
analyticsobject

AI-generated analysis of the asset content

]
Response
application/json
[
  {
    "_id": "6947b539cc95ea68854bb523",
    "displayName": "product-demo.mp4",
    "uploadPath": "https://content.shuffll.com/workspace/product-demo.mp4",
    "dashPath": "https://content.shuffll.com/workspace/product-demo.mpd",
    "mimetype": "video/mp4",
    "type": "video",
    "folder": "/",
    "userEmail": "user@example.com",
    "createdAt": "2025-12-15T07:26:34.333Z",
    "aspectRatio": "16:9"
  },
  {
    "_id": "6947b539cc95ea68854bb524",
    "displayName": "company-logo.png",
    "uploadPath": "https://content.shuffll.com/workspace/company-logo.png",
    "mimetype": "image/png",
    "type": "image",
    "folder": "/",
    "userEmail": "user@example.com",
    "createdAt": "2025-12-10T10:00:00.000Z"
  }
]

Upload asset

Request

Upload one or more files to a workspace as assets.

Files are uploaded as multipart/form-data. Each uploaded file becomes an asset in the workspace.

For video files, a DASH streaming version is automatically generated.

The returned uploadPath on each asset is the CDN URL that can be used directly in videosToAdd[].url when creating a project.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
Query
folderstring

Target folder path for the uploaded file (defaults to /)

Example: folder=/
Bodymultipart/form-datarequired
filestring(binary)

The file to upload. Supported types — images (JPEG, PNG, GIF, WebP, SVG), videos (MP4, MOV, WebM), audio (MP3, WAV, OGG), and PDFs.

curl -i -X POST \
  'https://api-docs.shuffll.com/_mock/apis/auth/workspace/693fb82afd8d1c43077ba0fe/assets?folder=%2F' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -F file=string

Responses

Files uploaded successfully.

Bodyapplication/json
uploadedArray of objects(Asset)

Array of successfully uploaded assets

Response
application/json
{
  "uploaded": [
    { … }
  ]
}

Delete assets

Request

Delete one or more assets from a workspace by their IDs.

This action is permanent and cannot be undone.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
Bodyapplication/jsonrequired
assetIdsstring or Array of stringsrequired
Example: ["6947b539cc95ea68854bb523","6947b539cc95ea68854bb524"]
One of:

Single asset ID

string
curl -i -X DELETE \
  https://api-docs.shuffll.com/_mock/apis/auth/workspace/693fb82afd8d1c43077ba0fe/assets \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "assetIds": [
      "6947b539cc95ea68854bb523",
      "6947b539cc95ea68854bb524"
    ]
  }'

Responses

Assets deleted successfully.

Response
No content

Create folder

Request

Create a new folder in the workspace asset library.

Folders are used to organize assets. The folder name must be unique within the workspace.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
Bodyapplication/jsonrequired
newNamestringrequired

Folder name (must be unique in the workspace)

Example: "Campaign Assets"
curl -i -X POST \
  https://api-docs.shuffll.com/_mock/apis/auth/workspace/693fb82afd8d1c43077ba0fe/assets/folder \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "newName": "Campaign Assets"
  }'

Responses

Folder created successfully.

Bodyapplication/json
successboolean
Example: true
Response
application/json
{
  "success": true
}

Move assets

Request

Move one or more assets to a different folder.

The target folder must exist. Use POST /auth/workspace/{workspaceId}/assets/folder to create a folder first if needed.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
Bodyapplication/jsonrequired
toFolderstringrequired

Target folder path to move the assets into

Example: "/Campaign Assets"
assetIdsstring or Array of stringsrequired
Example: ["6947b539cc95ea68854bb523"]
One of:

Single asset ID

string
curl -i -X PUT \
  https://api-docs.shuffll.com/_mock/apis/auth/workspace/693fb82afd8d1c43077ba0fe/assets/move \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "toFolder": "/Campaign Assets",
    "assetIds": [
      "6947b539cc95ea68854bb523"
    ]
  }'

Responses

Assets moved successfully.

Response
No content

Rename asset

Request

Rename an existing asset by updating its display name.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
assetIdstringrequired

Unique identifier for the asset

Example: 6947b539cc95ea68854bb523
Bodyapplication/jsonrequired
newNamestringrequired

New display name for the asset

Example: "final-product-demo.mp4"
curl -i -X PUT \
  https://api-docs.shuffll.com/_mock/apis/auth/workspace/693fb82afd8d1c43077ba0fe/assets/6947b539cc95ea68854bb523/file \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "newName": "final-product-demo.mp4"
  }'

Responses

Asset renamed successfully.

Bodyapplication/json
successboolean
Example: true
Response
application/json
{
  "success": true
}

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