{"items":[{"type":"link","fsPath":"guides/quickstart.md","metadata":{"type":"markdown"},"label":"Quickstart","link":"/guides/quickstart","routeSlug":"/guides/quickstart"},{"type":"group","fsPath":"integrations/index.md","metadata":{"type":"markdown"},"label":"Integrations","link":"/integrations","routeSlug":"/integrations","items":[{"type":"link","fsPath":"integrations/make-integration.md","metadata":{"type":"markdown"},"label":"Connect to Make.com","link":"/integrations/make-integration","routeSlug":"/integrations/make-integration"},{"type":"link","fsPath":"integrations/iframe-integration.md","metadata":{"type":"markdown"},"label":"Embed Shuffll's iFrame in Your App","link":"/integrations/iframe-integration","routeSlug":"/integrations/iframe-integration"},{"type":"link","fsPath":"integrations/zapier-integration.md","metadata":{"type":"markdown"},"label":"Connect Shuffll to Zapier (Coming Soon)","link":"/integrations/zapier-integration","routeSlug":"/integrations/zapier-integration"}]},{"type":"group","fsPath":"guides/index.md","metadata":{"type":"markdown"},"label":"Concepts","link":"/guides","routeSlug":"/guides","items":[{"type":"link","fsPath":"guides/concepts-entities.md","metadata":{"type":"markdown"},"label":"Core Entities","link":"/guides/concepts-entities","routeSlug":"/guides/concepts-entities"},{"type":"link","fsPath":"guides/workflow-project-creation.md","metadata":{"type":"markdown"},"label":"Project Creation","link":"/guides/workflow-project-creation","routeSlug":"/guides/workflow-project-creation"},{"type":"link","fsPath":"guides/workflow-video-generation.md","metadata":{"type":"markdown"},"label":"Video Generation and the Media Fallback System","link":"/guides/workflow-video-generation","routeSlug":"/guides/workflow-video-generation"},{"type":"link","fsPath":"guides/workflow-enhancement.md","metadata":{"type":"markdown"},"label":"Enhancement","link":"/guides/workflow-enhancement","routeSlug":"/guides/workflow-enhancement"},{"type":"link","fsPath":"guides/workflow-export.md","metadata":{"type":"markdown"},"label":"Export","link":"/guides/workflow-export","routeSlug":"/guides/workflow-export"},{"type":"link","fsPath":"guides/workflow-templates.md","metadata":{"type":"markdown"},"label":"Using Templates","link":"/guides/workflow-templates","routeSlug":"/guides/workflow-templates"}]},{"type":"group","fsPath":"apis/index.yaml","link":"/apis","routeSlug":"/apis","label":"API Reference","items":[{"type":"group","label":"Configuration","link":"/apis/configuration","routeSlug":"/apis/configuration","items":[{"label":"Get storytelling techniques","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/configuration/getstorytellingtechniques","routeSlug":"/apis/configuration/getstorytellingtechniques","metadata":{"seo":{"title":"Get storytelling techniques","description":"Retrieve all available storytelling techniques for video creation. Returns an array of 12 storytelling techniques with descriptions, explanations of why they work, and examples."}},"httpPath":"/auth/config/storytelling_techniques"},{"label":"Get tone of voice options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/configuration/gettoneofvoice","routeSlug":"/apis/configuration/gettoneofvoice","metadata":{"seo":{"title":"Get tone of voice options","description":"Retrieve all available tone of voice options for video narration.Returns an array of tone options with descriptions."}},"httpPath":"/auth/config/tone_of_voice"},{"label":"Get video category tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/configuration/getvideotags","routeSlug":"/apis/configuration/getvideotags","metadata":{"seo":{"title":"Get video category tags","description":"Retrieve all available video category tags."}},"httpPath":"/auth/config/video_tags"},{"label":"Get AI voice options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/configuration/getaivoiceoptions","routeSlug":"/apis/configuration/getaivoiceoptions","metadata":{"seo":{"title":"Get AI voice options","description":"Retrieve all available AI voice-over options and tone styles."}},"httpPath":"/auth/config/ai_voice_options"},{"label":"Get AI avatar options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/configuration/getaiavataroptions","routeSlug":"/apis/configuration/getaiavataroptions","metadata":{"seo":{"title":"Get AI avatar options","description":"Retrieve all available AI avatar presenter options."}},"httpPath":"/auth/config/ai_avatar_options"},{"label":"Get background music library","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/configuration/getmusiclibrary","routeSlug":"/apis/configuration/getmusiclibrary","metadata":{"seo":{"title":"Get background music library","description":"Retrieve all available background music tracks."}},"httpPath":"/auth/config/music-library"}]},{"type":"group","label":"Organizations","link":"/apis/organizations","routeSlug":"/apis/organizations","items":[{"label":"Get organization list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organizations/getorganizationlist","routeSlug":"/apis/organizations/getorganizationlist","metadata":{"seo":{"title":"Get organization list","description":"Retrieve array of all organizations the user has access to."}},"httpPath":"/auth/organization/list"},{"label":"Get specific organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/organizations/getorganizationbyid","routeSlug":"/apis/organizations/getorganizationbyid","metadata":{"seo":{"title":"Get specific organization","description":"Retrieve detailed information about a specific organization including: - Organization ID and name - All workspaces with detailed metrics (asset count, project count, template count) - Complete branding configuration - User information"}},"httpPath":"/auth/organization/{organizationId}"}]},{"type":"group","label":"Workspaces","link":"/apis/workspaces","routeSlug":"/apis/workspaces","items":[{"label":"Get workspace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workspaces/getworkspacebyid","routeSlug":"/apis/workspaces/getworkspacebyid","metadata":{"seo":{"title":"Get workspace","description":"Retrieve detailed information about a specific workspace including: - Workspace ID and name - Metrics (asset count, project count, template count, user count) - Complete branding configuration - Video prompts and ideas - Creator information"}},"httpPath":"/auth/organization/{organizationId}/workspace/{workspaceId}"},{"label":"Update workspace","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workspaces/updateworkspace","routeSlug":"/apis/workspaces/updateworkspace","metadata":{"seo":{"title":"Update workspace","description":"Update fields on a specific workspace."}},"httpPath":"/auth/organization/{organizationId}/workspace/{workspaceId}"},{"label":"List workspace projects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/workspaces/listworkspaceprojects","routeSlug":"/apis/workspaces/listworkspaceprojects","metadata":{"seo":{"title":"List workspace projects","description":"Retrieve all projects in a specific workspace."}},"httpPath":"/auth/workspace/{workspaceId}/projects"}]},{"type":"group","label":"Branding","link":"/apis/branding","routeSlug":"/apis/branding","items":[{"label":"Get branding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/branding/getbranding","routeSlug":"/apis/branding/getbranding","metadata":{"seo":{"title":"Get branding","description":"Retrieve the branding configuration for a workspace or organization."}},"httpPath":"/auth/branding/entity"},{"label":"Update branding property","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/branding/updatebranding","routeSlug":"/apis/branding/updatebranding","metadata":{"seo":{"title":"Update branding property","description":"Update a single branding property for a workspace or organization."}},"httpPath":"/auth/branding/entity"}]},{"type":"group","label":"Assets","link":"/apis/assets","routeSlug":"/apis/assets","items":[{"label":"List assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/assets/listassets","routeSlug":"/apis/assets/listassets","metadata":{"seo":{"title":"List assets","description":"Retrieve all assets in a workspace."}},"httpPath":"/auth/workspace/{workspaceId}/assets"},{"label":"Upload asset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/assets/uploadasset","routeSlug":"/apis/assets/uploadasset","metadata":{"seo":{"title":"Upload asset","description":"Upload one or more files to a workspace as assets."}},"httpPath":"/auth/workspace/{workspaceId}/assets"},{"label":"Delete assets","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/assets/deleteassets","routeSlug":"/apis/assets/deleteassets","metadata":{"seo":{"title":"Delete assets","description":"Delete one or more assets from a workspace by their IDs."}},"httpPath":"/auth/workspace/{workspaceId}/assets"},{"label":"Create folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/assets/createassetfolder","routeSlug":"/apis/assets/createassetfolder","metadata":{"seo":{"title":"Create folder","description":"Create a new folder in the workspace asset library."}},"httpPath":"/auth/workspace/{workspaceId}/assets/folder"},{"label":"Move assets","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/assets/moveassets","routeSlug":"/apis/assets/moveassets","metadata":{"seo":{"title":"Move assets","description":"Move one or more assets to a different folder."}},"httpPath":"/auth/workspace/{workspaceId}/assets/move"},{"label":"Rename asset","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/assets/renameasset","routeSlug":"/apis/assets/renameasset","metadata":{"seo":{"title":"Rename asset","description":"Rename an existing asset by updating its display name."}},"httpPath":"/auth/workspace/{workspaceId}/assets/{assetId}/file"}]},{"type":"group","label":"Templates","link":"/apis/templates","routeSlug":"/apis/templates","items":[{"label":"Get all templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/templates/getalltemplates","routeSlug":"/apis/templates/getalltemplates","metadata":{"seo":{"title":"Get all templates","description":"Retrieve a list of all templates you have created in your account."}},"httpPath":"/auth/templates"},{"label":"Get templates by organization and workspace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/templates/gettemplatesbyorgworkspace","routeSlug":"/apis/templates/gettemplatesbyorgworkspace","metadata":{"seo":{"title":"Get templates by organization and workspace","description":"Retrieve all templates for a specific organization and workspace."}},"httpPath":"/auth/organization/{organizationId}/workspace/{workspaceId}/templates"},{"label":"Get specific template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/templates/gettemplatebyid","routeSlug":"/apis/templates/gettemplatebyid","metadata":{"seo":{"title":"Get specific template","description":"Retrieve detailed information about a specific template including: - Template ID, name, and description - All scenes with their types and order - Dynamic fields for each scene (headers, colors, texts, voice settings, etc.) - Scene configuration options"}},"httpPath":"/auth/templates/{templateId}"}]},{"type":"group","label":"Projects","link":"/apis/projects","routeSlug":"/apis/projects","items":[{"label":"Create project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/projects/createproject","routeSlug":"/apis/projects/createproject","metadata":{"seo":{"title":"Create project","description":"Create a new AI-powered video project from a prompt, URL, or script."}},"httpPath":"/auth/project/create"},{"label":"Get project creation status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/projects/getprojectcreatestatus","routeSlug":"/apis/projects/getprojectcreatestatus","metadata":{"seo":{"title":"Get project creation status","description":"Poll this endpoint after creating a project to track AI generation progress."}},"httpPath":"/auth/project/{projectId}/create/status"},{"label":"Get project","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/projects/getprojectbyid","routeSlug":"/apis/projects/getprojectbyid","metadata":{"seo":{"title":"Get project","description":"Retrieve the full details of a specific project, including its current status, name, and workspace."}},"httpPath":"/auth/project/{projectId}"},{"label":"Delete project","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/projects/deleteproject","routeSlug":"/apis/projects/deleteproject","metadata":{"seo":{"title":"Delete project","description":"Permanently delete a project and all associated data."}},"httpPath":"/auth/project/{projectId}"}]},{"type":"group","label":"Enhance","link":"/apis/enhance","routeSlug":"/apis/enhance","items":[{"label":"Get project enhancement status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/enhance/getenhancestatus","routeSlug":"/apis/enhance/getenhancestatus","metadata":{"seo":{"title":"Get project enhancement status","description":"Check the progress of the automatic enhancement process for a project."}},"httpPath":"/auth/project/{projectId}/edit/status/enhance"}]},{"type":"group","label":"Export","link":"/apis/export","routeSlug":"/apis/export","items":[{"label":"Export project","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/export/exportproject","routeSlug":"/apis/export/exportproject","metadata":{"seo":{"title":"Export project","description":"Trigger the export of a completed project to a video file."}},"httpPath":"/auth/project/{projectId}/edit/export"},{"label":"Get project export status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/export/getexportstatus","routeSlug":"/apis/export/getexportstatus","metadata":{"seo":{"title":"Get project export status","description":"Check the progress of a project export job."}},"httpPath":"/auth/project/{projectId}/edit/status/export"}]}],"metadata":{"type":"openapi","title":"Shuffll API","version":"1.2.0","description":"The Shuffll API enables seamless automation and integration of Shuffll's AI-powered video creation platform into external workflows.\n\n**What is Shuffll?**\n\nShuffll 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.\n\nWith **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.\n\n**Key Features**\n\n- **AI-Driven Video Creation** – Generate videos automatically based on structured input, scripts, or templates.\n- **Smart Editing & Automation** – Apply transitions, overlays, and effects without manual editing.\n- **Custom API Endpoints** – Programmatically generate, edit, and manage video content.\n- **Brand Consistency** – Ensure that videos align with predefined brand styles and messaging.\n- **Seamless Integrations** – Connect with third-party tools, media libraries, and content management systems.\n\nShuffll's API empowers developers to automate video production, integrate AI-enhanced video workflows, and create personalized video content at scale—all with minimal effort.\n"}},{"type":"link","fsPath":"changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/changelog","routeSlug":"/changelog"},{"type":"link","fsPath":"contact.md","metadata":{"type":"markdown"},"label":"Contact Us","link":"/contact","routeSlug":"/contact"}]}