Skip to content
API Reference/
/
Get branding

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

Get branding

Request

Retrieve the branding configuration for a workspace or organization.

Pass either workspaceId or organizationId as a query parameter to specify which entity's branding to retrieve.

Security
ShuffllApiKey
Query
workspaceIdstring

ID of the workspace to retrieve branding for

Example: workspaceId=693fb82afd8d1c43077ba0fe
organizationIdstring

ID of the organization to retrieve branding for (used when no workspace is specified)

Example: organizationId=693fb82afd8d1c43077ba0fb
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/apis/auth/branding/entity?workspaceId=693fb82afd8d1c43077ba0fe&organizationId=693fb82afd8d1c43077ba0fb' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved branding.

Bodyapplication/json
companyobject

Company information

isDefaultboolean

Whether using default branding settings

Example: true
enabledboolean

Whether branding is enabled

Example: true
logostring

Path to company logo

Example: "/files/platform/onboarding/logo-placeholder.svg"
logoWstring

Path to white version of logo

Example: "/files/platform/onboarding/logo-placeholder.svg"
colorsobject

Brand color palette

promptsArray of objects

User's saved prompts with tags and suggestions

aboutstring

Company description used by AI when writing video scripts

Example: "Acme Corp builds innovative solutions for enterprise teams."
videoIdeasArray of objects

AI-generated video idea suggestions for the workspace

videoIdeaStatusstring

Status of the video idea generation

Example: "COMPLETED"
pronunciationsArray of objects

Custom pronunciation settings for brand, people, and product names in AI voiceovers

Response
application/json
{
  "isDefault": false,
  "enabled": true,
  "company": {
    "id": "acme-corp",
    "name": "Acme Corp",
    "domain": "acme.com",
    "minSize": null,
    "maxSize": null,
    "geoLocation": null
  },
  "logo": "https://content.shuffll.com/branding/acme-logo.png",
  "logoW": "https://content.shuffll.com/branding/acme-logo-white.png",
  "colors": {
    "colorPrimary": "#1a1a2e",
    "colorSecondary": "#16213e",
    "colorExtra": "#0f3460"
  },
  "about": "Acme Corp builds innovative solutions for enterprise teams.",
  "pronunciations": []
}

Update branding property

Request

Update a single branding property for a workspace or organization.

This endpoint uses a property-name/value pattern — each call updates one property at a time.

Supported propertyName values:

propertyNameTypeDescription
logostring (URL)Primary logo URL
logoWstring (URL)White/light logo URL
colorsobjectBrand color palette
companyobjectCompany metadata (name, domain, etc.)
aboutstringAbout text used in AI video scripts
pronunciationsarrayCustom pronunciation rules for AI voiceover
enabledbooleanEnable or disable branding

For colors, pass an object with colorPrimary, colorSecondary, and colorExtra hex values.

See the examples below for common update patterns.

Security
ShuffllApiKey
Bodyapplication/jsonrequired
workspaceobject

Target workspace. Required if updating workspace branding.

organizationobject

Target organization. Required if updating organization branding (and no workspace is specified).

propertyNamestringrequired

The branding property to update

Enum"logo""logoW""colors""company""about""pronunciations""enabled"
Example: "colors"
propertyValueanyrequired

The new value for the property. Shape depends on propertyName:

  • logo / logoW: string (URL)
  • colors: { colorPrimary: string, colorSecondary: string, colorExtra: string }
  • company: { name: string, domain: string, geoLocation?: string }
  • about: string
  • pronunciations: array of pronunciation objects
  • enabled: boolean
Example: {"colorPrimary":"#1a1a2e","colorSecondary":"#16213e","colorExtra":"#0f3460"}
socketIdToExcludestring

Optional socket ID to exclude from real-time update notifications

curl -i -X PUT \
  https://api-docs.shuffll.com/_mock/apis/auth/branding/entity \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "workspace": {
      "id": "693fb82afd8d1c43077ba0fe"
    },
    "propertyName": "colors",
    "propertyValue": {
      "colorPrimary": "#1a1a2e",
      "colorSecondary": "#16213e",
      "colorExtra": "#0f3460"
    }
  }'

Responses

Branding updated successfully.

Response
No content

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