{"items":[{"type":"link","label":"Shuffll API","link":"/apis","routeSlug":"/apis","content":{"contentType":"overview","meta":{"name":"Shuffll API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://shuffll.com","url":"https://shuffll.com"},{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"info@shuffll.com","label":"info@shuffll.com","withCopyButton":true,"copyContent":"info@shuffll.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://opensource.org/license/mit/"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://shuffll.com/terms-of-use/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Shuffll API (1.2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Shuffll API enables seamless automation and integration of Shuffll's AI-powered video creation platform into external workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What is Shuffll?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shuffll's API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", 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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Features"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI-Driven Video Creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Generate videos automatically based on structured input, scripts, or templates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Smart Editing & Automation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Apply transitions, overlays, and effects without manual editing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom API Endpoints"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Programmatically generate, edit, and manage video content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand Consistency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Ensure that videos align with predefined brand styles and messaging."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seamless Integrations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Connect with third-party tools, media libraries, and content management systems."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}],"sectionId":"/apis"}],"sectionId":"/apis"}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStorytellingTechniques","name":"Get storytelling techniques","isWebhook":false,"pointer":"/paths/~1auth~1config~1storytelling_techniques/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get storytelling techniques","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all available storytelling techniques for video creation.\nReturns an array of 12 storytelling techniques with descriptions, explanations of why they work, and examples.\n\nUse these techniques when creating projects to structure your video narrative effectively.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/config/storytelling_techniques","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/config/storytelling_techniques","href":"configuration/getstorytellingtechniques","openApiOperationId":"getStorytellingTechniques","summary":"Get storytelling techniques"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved storytelling techniques.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StorytellingTechniquesResponse","exampleIds":["paths/~1auth~1config~1storytelling_techniques/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/StorytellingTechniquesResponse","exampleIds":["paths/~1auth~1config~1storytelling_techniques/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1config~1storytelling_techniques/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StorytellingTechniquesResponse","exampleIds":["paths/~1auth~1config~1storytelling_techniques/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StorytellingTechniquesResponse","exampleIds":["paths/~1auth~1config~1storytelling_techniques/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/getstorytellingtechniques"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getToneOfVoice","name":"Get tone of voice options","isWebhook":false,"pointer":"/paths/~1auth~1config~1tone_of_voice/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tone of voice options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all available tone of voice options for video narration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an array of tone options with descriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toneOfVoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/config/tone_of_voice","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/config/tone_of_voice","href":"configuration/gettoneofvoice","openApiOperationId":"getToneOfVoice","summary":"Get tone of voice options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved tone of voice options.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ToneOfVoiceResponse","exampleIds":["paths/~1auth~1config~1tone_of_voice/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ToneOfVoiceResponse","exampleIds":["paths/~1auth~1config~1tone_of_voice/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1config~1tone_of_voice/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ToneOfVoiceResponse","exampleIds":["paths/~1auth~1config~1tone_of_voice/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ToneOfVoiceResponse","exampleIds":["paths/~1auth~1config~1tone_of_voice/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/gettoneofvoice"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVideoTags","name":"Get video category tags","isWebhook":false,"pointer":"/paths/~1auth~1config~1video_tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get video category tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all available video category tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videoTagId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project to categorize your video (e.g., Marketing, Explainer, Training)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/config/video_tags","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/config/video_tags","href":"configuration/getvideotags","openApiOperationId":"getVideoTags","summary":"Get video category tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved video tags.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoTagsResponse","exampleIds":["paths/~1auth~1config~1video_tags/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/VideoTagsResponse","exampleIds":["paths/~1auth~1config~1video_tags/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1config~1video_tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VideoTagsResponse","exampleIds":["paths/~1auth~1config~1video_tags/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoTagsResponse","exampleIds":["paths/~1auth~1config~1video_tags/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/getvideotags"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAiVoiceOptions","name":"Get AI voice options","isWebhook":false,"pointer":"/paths/~1auth~1config~1ai_voice_options/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get AI voice options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all available AI voice-over options and tone styles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns two arrays:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiVoiceOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the list of available voices. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiVoiceSettings.voiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiVoiceTones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — tone styles that can be layered on top of a voice (e.g., friendly, professional, dramatic)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voices are provided by either OpenAI or ElevenLabs depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/config/ai_voice_options","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/config/ai_voice_options","href":"configuration/getaivoiceoptions","openApiOperationId":"getAiVoiceOptions","summary":"Get AI voice options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved AI voice options.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AiVoiceOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_voice_options/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/AiVoiceOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_voice_options/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1config~1ai_voice_options/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AiVoiceOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_voice_options/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AiVoiceOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_voice_options/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/getaivoiceoptions"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAiAvatarOptions","name":"Get AI avatar options","isWebhook":false,"pointer":"/paths/~1auth~1config~1ai_avatar_options/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get AI avatar options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all available AI avatar presenter options."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each avatar has a name, accent, and a preview video URL. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value when configuring an AI avatar presenter for your project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/config/ai_avatar_options","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/config/ai_avatar_options","href":"configuration/getaiavataroptions","openApiOperationId":"getAiAvatarOptions","summary":"Get AI avatar options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved AI avatar options.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AiAvatarOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_avatar_options/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/AiAvatarOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_avatar_options/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1config~1ai_avatar_options/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AiAvatarOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_avatar_options/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AiAvatarOptionsResponse","exampleIds":["paths/~1auth~1config~1ai_avatar_options/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/getaiavataroptions"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMusicLibrary","name":"Get background music library","isWebhook":false,"pointer":"/paths/~1auth~1config~1music-library/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get background music library","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all available background music tracks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relativePath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customTemplate.preConfigs.bgMusic.path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project to set the background music."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/config/music-library","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/config/music-library","href":"configuration/getmusiclibrary","openApiOperationId":"getMusicLibrary","summary":"Get background music library"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved music library.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MusicLibraryResponse","exampleIds":["paths/~1auth~1config~1music-library/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/MusicLibraryResponse","exampleIds":["paths/~1auth~1config~1music-library/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1config~1music-library/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MusicLibraryResponse","exampleIds":["paths/~1auth~1config~1music-library/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MusicLibraryResponse","exampleIds":["paths/~1auth~1config~1music-library/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configuration/getmusiclibrary"}],"panels":[]}]},"httpPath":"/auth/config/music-library"}],"content":{"contentType":"group","meta":{"name":"Configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configuration","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve available options for AI voices, avatars, background music, and video category tags. Call these endpoints to populate field values when creating a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/config/storytelling_techniques","summary":"Get storytelling techniques","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/getstorytellingtechniques","deprecated":false},{"title":"/auth/config/tone_of_voice","summary":"Get tone of voice options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/gettoneofvoice","deprecated":false},{"title":"/auth/config/video_tags","summary":"Get video category tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/getvideotags","deprecated":false},{"title":"/auth/config/ai_voice_options","summary":"Get AI voice options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/getaivoiceoptions","deprecated":false},{"title":"/auth/config/ai_avatar_options","summary":"Get AI avatar options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/getaiavataroptions","deprecated":false},{"title":"/auth/config/music-library","summary":"Get background music library","prefix":{"name":"get","color":"get"},"badges":[],"link":"/configuration/getmusiclibrary","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationList","name":"Get organization list","isWebhook":false,"pointer":"/paths/~1auth~1organization~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve array of all organizations the user has access to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns metadata for each organization including:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization ID and name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspaces within each organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branding configuration (colors, logos, company info)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video prompts and ideas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User access status and user count"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/organization/list","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/organization/list","href":"organizations/getorganizationlist","openApiOperationId":"getOrganizationList","summary":"Get organization list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved organization list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationsResponse","exampleIds":["paths/~1auth~1organization~1list/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/OrganizationsResponse","exampleIds":["paths/~1auth~1organization~1list/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1organization~1list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationsResponse","exampleIds":["paths/~1auth~1organization~1list/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationsResponse","exampleIds":["paths/~1auth~1organization~1list/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getorganizationlist"}],"panels":[]}]},"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationById","name":"Get specific organization","isWebhook":false,"pointer":"/paths/~1auth~1organization~1{organizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve detailed information about a specific organization including:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization ID and name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All workspaces with detailed metrics (asset count, project count, template count)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete branding configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_9","description":"Unique identifier for the organization","required":true}],"pointer":"/paths/~1auth~1organization~1{organizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/organization/{organizationId}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fb","schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/organization/{organizationId}","href":"organizations/getorganizationbyid","openApiOperationId":"getOrganizationById","summary":"Get specific organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved organization details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/OrganizationDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1organization~1{organizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/getorganizationbyid"}],"panels":[]}]},"httpPath":"/auth/organization/{organizationId}"}],"content":{"contentType":"group","meta":{"name":"Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations","showPageActions":true},{"nodeType":"markdoc","content":"Manage organizations and retrieve their workspaces, branding, and settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/organization/list","summary":"Get organization list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getorganizationlist","deprecated":false},{"title":"/auth/organization/{organizationId}","summary":"Get specific organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/getorganizationbyid","deprecated":false}]}]}]}]}},{"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkspaceById","name":"Get workspace","isWebhook":false,"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve detailed information about a specific workspace including:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace ID and name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics (asset count, project count, template count, user count)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete branding configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video prompts and ideas"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator information"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_9","description":"Unique identifier for the organization","required":true},{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/organization/{organizationId}/workspace/{workspaceId}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fb","schemaId":"schema_9"},{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/organization/{organizationId}/workspace/{workspaceId}","href":"workspaces/getworkspacebyid","openApiOperationId":"getWorkspaceById","summary":"Get workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved workspace details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/WorkspaceDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkspaceDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkspaceDetail","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workspaces/getworkspacebyid"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWorkspace","name":"Update workspace","isWebhook":false,"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update fields on a specific workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supports updating the workspace "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update workspace branding (logo, colors, company info), use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /auth/branding/entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_9","description":"Unique identifier for the organization","required":true},{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWorkspaceRequest","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/UpdateWorkspaceRequest","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/auth/organization/{organizationId}/workspace/{workspaceId}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fb","schemaId":"schema_9"},{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateWorkspaceRequest","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","400","401","404"],"pointer":"/auth/organization/{organizationId}/workspace/{workspaceId}","href":"workspaces/updateworkspace","openApiOperationId":"updateWorkspace","summary":"Update workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/UpdateWorkspaceRequest","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWorkspaceRequest","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Workspace updated successfully."},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workspaces/updateworkspace"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWorkspaceProjects","name":"List workspace projects","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1projects/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List workspace projects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all projects in a specific workspace.\n\nReturns a list of project summaries including each project's ID, name, current status, and creation date.\nUse this endpoint to enumerate existing projects before exporting or checking their status.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1projects/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/workspace/{workspaceId}/projects","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/workspace/{workspaceId}/projects","href":"workspaces/listworkspaceprojects","openApiOperationId":"listWorkspaceProjects","summary":"List workspace projects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved project list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workspaces/listworkspaceprojects"}],"panels":[]}]},"httpPath":"/auth/workspace/{workspaceId}/projects"}],"content":{"contentType":"group","meta":{"name":"Workspaces"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workspaces","showPageActions":true},{"nodeType":"markdoc","content":"Manage workspaces within an organization, and list projects within a workspace."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/organization/{organizationId}/workspace/{workspaceId}","summary":"Get workspace","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspaces/getworkspacebyid","deprecated":false},{"title":"/auth/organization/{organizationId}/workspace/{workspaceId}","summary":"Update workspace","prefix":{"name":"put","color":"put"},"badges":[],"link":"/workspaces/updateworkspace","deprecated":false},{"title":"/auth/workspace/{workspaceId}/projects","summary":"List workspace projects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workspaces/listworkspaceprojects","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBranding","name":"Get branding","isWebhook":false,"pointer":"/paths/~1auth~1branding~1entity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get branding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the branding configuration for a workspace or organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspaceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organizationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a query parameter to specify which entity's branding to retrieve."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"workspaceId","in":"query","schemaId":"schema_10","description":"ID of the workspace to retrieve branding for"},{"name":"organizationId","in":"query","schemaId":"schema_9","description":"ID of the organization to retrieve branding for (used when no workspace is specified)"}],"pointer":"/paths/~1auth~1branding~1entity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/branding/entity","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[{"name":"workspaceId","in":"query","example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"},{"name":"organizationId","in":"query","example":"693fb82afd8d1c43077ba0fb","schemaId":"schema_9"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/branding/entity","href":"branding/getbranding","openApiOperationId":"getBranding","summary":"Get branding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved branding.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBranding","exampleIds":["paths/~1auth~1branding~1entity/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/UserBranding","exampleIds":["paths/~1auth~1branding~1entity/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1branding~1entity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserBranding","exampleIds":["paths/~1auth~1branding~1entity/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBranding","exampleIds":["paths/~1auth~1branding~1entity/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branding/getbranding"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBranding","name":"Update branding property","isWebhook":false,"pointer":"/paths/~1auth~1branding~1entity/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update branding property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a single branding property for a workspace or organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses a property-name/value pattern — each call updates one property at a time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyName"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary logo URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logoW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"White/light logo URL"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colors"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand color palette"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company metadata (name, domain, etc.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"about"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"About text used in AI video scripts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pronunciations"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom pronunciation rules for AI voiceover"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable or disable branding"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass an object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colorPrimary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colorSecondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colorExtra"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hex values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the examples below for common update patterns."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBrandingRequest","exampleIds":["paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company"]}},"schemaId":"components/schemas/UpdateBrandingRequest","exampleIds":["paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company"],"pointer":"/paths/~1auth~1branding~1entity/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/auth/branding/entity","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBrandingRequest","exampleIds":["paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company"]}},"responseCodes":["200","400","401","404"],"pointer":"/auth/branding/entity","href":"branding/updatebranding","openApiOperationId":"updateBranding","summary":"Update branding property"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/UpdateBrandingRequest","exampleIds":["paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBrandingRequest","exampleIds":["paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo","paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Branding updated successfully."},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1branding~1entity/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branding/updatebranding"}],"panels":[]}]},"httpPath":"/auth/branding/entity"}],"content":{"contentType":"group","meta":{"name":"Branding"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Branding","showPageActions":true},{"nodeType":"markdoc","content":"Read and update branding configuration (logo, colors, company info, pronunciations) for a workspace or organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/branding/entity","summary":"Get branding","prefix":{"name":"get","color":"get"},"badges":[],"link":"/branding/getbranding","deprecated":false},{"title":"/auth/branding/entity","summary":"Update branding property","prefix":{"name":"put","color":"put"},"badges":[],"link":"/branding/updatebranding","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAssets","name":"List assets","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List assets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all assets in a workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to filter by asset type (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to list assets within a specific folder path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on each asset is the CDN URL you can use directly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videosToAdd[].url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter assets by type prefix (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"video"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"name":"folder","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter assets by folder path (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/my-folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/workspace/{workspaceId}/assets","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[{"name":"type","in":"query","example":"video","schemaId":"schema_11"},{"name":"folder","in":"query","example":"/","schemaId":"schema_12"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/workspace/{workspaceId}/assets","href":"assets/listassets","openApiOperationId":"listAssets","summary":"List assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved assets.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/AssetsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetsListResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/listassets"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAsset","name":"Upload asset","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload one or more files to a workspace as assets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files are uploaded as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each uploaded file becomes an asset in the workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For video files, a DASH streaming version is automatically generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on each asset is the CDN URL that can be used directly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videosToAdd[].url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"folder","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target folder path for the uploaded file (defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_13"}},"schemaId":"schema_13","pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/workspace/{workspaceId}/assets","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[{"name":"folder","in":"query","example":"/","schemaId":"schema_12"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_13"}},"responseCodes":["200","400","401"],"pointer":"/auth/workspace/{workspaceId}/assets","href":"assets/uploadasset","openApiOperationId":"uploadAsset","summary":"Upload asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"schema_13","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_13"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Files uploaded successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadAssetsResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/UploadAssetsResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadAssetsResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadAssetsResponse","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/uploadasset"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAssets","name":"Delete assets","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete assets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete one or more assets from a workspace by their IDs.\n\nThis action is permanent and cannot be undone.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/DeleteAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/auth/workspace/{workspaceId}/assets","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeleteAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","400","401"],"pointer":"/auth/workspace/{workspaceId}/assets","href":"assets/deleteassets","openApiOperationId":"deleteAssets","summary":"Delete assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/DeleteAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assets deleted successfully."},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/deleteassets"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAssetFolder","name":"Create folder","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new folder in the workspace asset library.\n\nFolders are used to organize assets. The folder name must be unique within the workspace.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateFolderRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/CreateFolderRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/workspace/{workspaceId}/assets/folder","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateFolderRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","400","401"],"pointer":"/auth/workspace/{workspaceId}/assets/folder","href":"assets/createassetfolder","openApiOperationId":"createAssetFolder","summary":"Create folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/CreateFolderRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateFolderRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Folder created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/createassetfolder"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"moveAssets","name":"Move assets","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move assets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Move one or more assets to a different folder."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target folder must exist. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /auth/workspace/{workspaceId}/assets/folder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a folder first if needed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MoveAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/MoveAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/auth/workspace/{workspaceId}/assets/move","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MoveAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","400","401"],"pointer":"/auth/workspace/{workspaceId}/assets/move","href":"assets/moveassets","openApiOperationId":"moveAssets","summary":"Move assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/MoveAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MoveAssetsRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Assets moved successfully."},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/moveassets"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renameAsset","name":"Rename asset","isWebhook":false,"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rename an existing asset by updating its display name.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true},{"name":"assetId","in":"path","schemaId":"schema_15","description":"Unique identifier for the asset","required":true}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenameAssetRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/RenameAssetRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example"],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/auth/workspace/{workspaceId}/assets/{assetId}/file","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"},{"name":"assetId","in":"path","required":true,"example":"6947b539cc95ea68854bb523","schemaId":"schema_15"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RenameAssetRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example"]}},"responseCodes":["200","400","401","404"],"pointer":"/auth/workspace/{workspaceId}/assets/{assetId}/file","href":"assets/renameasset","openApiOperationId":"renameAsset","summary":"Rename asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/RenameAssetRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenameAssetRequest","exampleIds":["paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Asset renamed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/renameasset"}],"panels":[]}]},"httpPath":"/auth/workspace/{workspaceId}/assets/{assetId}/file"}],"content":{"contentType":"group","meta":{"name":"Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assets","showPageActions":true},{"nodeType":"markdoc","content":"Upload, organize, rename, move, and delete media assets in a workspace. Assets can be referenced directly in project creation requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/workspace/{workspaceId}/assets","summary":"List assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/listassets","deprecated":false},{"title":"/auth/workspace/{workspaceId}/assets","summary":"Upload asset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/uploadasset","deprecated":false},{"title":"/auth/workspace/{workspaceId}/assets","summary":"Delete assets","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/assets/deleteassets","deprecated":false},{"title":"/auth/workspace/{workspaceId}/assets/folder","summary":"Create folder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/createassetfolder","deprecated":false},{"title":"/auth/workspace/{workspaceId}/assets/move","summary":"Move assets","prefix":{"name":"put","color":"put"},"badges":[],"link":"/assets/moveassets","deprecated":false},{"title":"/auth/workspace/{workspaceId}/assets/{assetId}/file","summary":"Rename asset","prefix":{"name":"put","color":"put"},"badges":[],"link":"/assets/renameasset","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllTemplates","name":"Get all templates","isWebhook":false,"pointer":"/paths/~1auth~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all templates you have created in your account.\n\nTemplates are reusable video project structures that define scene order, types, and configurations.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/templates","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/auth/templates","href":"templates/getalltemplates","openApiOperationId":"getAllTemplates","summary":"Get all templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved templates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1templates/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1templates/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1templates/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1templates/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/getalltemplates"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplatesByOrgWorkspace","name":"Get templates by organization and workspace","isWebhook":false,"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get templates by organization and workspace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all templates for a specific organization and workspace.\n\nThis endpoint allows you to get templates from a particular organization and workspace rather than the default ones.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organizationId","in":"path","schemaId":"schema_9","description":"Unique identifier for the organization","required":true},{"name":"workspaceId","in":"path","schemaId":"schema_10","description":"Unique identifier for the workspace","required":true}],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/organization/{organizationId}/workspace/{workspaceId}/templates","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"organizationId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fb","schemaId":"schema_9"},{"name":"workspaceId","in":"path","required":true,"example":"693fb82afd8d1c43077ba0fe","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/organization/{organizationId}/workspace/{workspaceId}/templates","href":"templates/gettemplatesbyorgworkspace","openApiOperationId":"getTemplatesByOrgWorkspace","summary":"Get templates by organization and workspace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved templates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplatesResponse","exampleIds":["paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/gettemplatesbyorgworkspace"}],"panels":[]}]},"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:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplateById","name":"Get specific template","isWebhook":false,"pointer":"/paths/~1auth~1templates~1{templateId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve detailed information about a specific template including:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template ID, name, and description"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All scenes with their types and order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic fields for each scene (headers, colors, texts, voice settings, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scene configuration options"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to understand the template structure before creating a project from it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateId","in":"path","schemaId":"schema_16","description":"Unique identifier for the template","required":true}],"pointer":"/paths/~1auth~1templates~1{templateId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/templates/{templateId}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"templateId","in":"path","required":true,"example":"67682e831de738f85b0d0fc9","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/templates/{templateId}","href":"templates/gettemplatebyid","openApiOperationId":"getTemplateById","summary":"Get specific template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully retrieved template details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For the project creation process, you can provide initial values for scenes using the dynamic values through the API."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetail","exampleIds":["paths/~1auth~1templates~1{templateId}/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/TemplateDetail","exampleIds":["paths/~1auth~1templates~1{templateId}/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1templates~1{templateId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TemplateDetail","exampleIds":["paths/~1auth~1templates~1{templateId}/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TemplateDetail","exampleIds":["paths/~1auth~1templates~1{templateId}/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/gettemplatebyid"}],"panels":[]}]},"httpPath":"/auth/templates/{templateId}"}],"content":{"contentType":"group","meta":{"name":"Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates","showPageActions":true},{"nodeType":"markdoc","content":"Browse and retrieve reusable video templates. Templates define the scene structure and visual style of a project."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/templates","summary":"Get all templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/getalltemplates","deprecated":false},{"title":"/auth/organization/{organizationId}/workspace/{workspaceId}/templates","summary":"Get templates by organization and workspace","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/gettemplatesbyorgworkspace","deprecated":false},{"title":"/auth/templates/{templateId}","summary":"Get specific template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/gettemplatebyid","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProject","name":"Create project","isWebhook":false,"pointer":"/paths/~1auth~1project~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new AI-powered video project from a prompt, URL, or script."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"projects/createproject/request/prompt-types","deepLinkHash":"/projects/createproject#projects/createproject/request/prompt-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prompt Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promptType"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prompt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A free-text description of the video topic (default)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A public URL — Shuffll scrapes the content and uses it as the basis for the script"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Docs"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Google Docs URL — Shuffll reads the document content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Slides"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Google Slides URL — Shuffll reads the slide content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Script"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pre-written script — AI generation is skipped, the script is used as-is"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"projects/createproject/request/scene-media-fallback-system","deepLinkHash":"/projects/createproject#projects/createproject/request/scene-media-fallback-system"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scene Media — Fallback System"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each scene, Shuffll fills in media content using the following priority order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a source doesn't yield results, it automatically tries the next one."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your videos"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customTemplate.scenes[].videosToAdd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — Videos you explicitly provide are always used first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock footage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Shuffll searches stock video libraries for footage matching the scene content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Workspace assets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Shuffll looks in your workspace asset library for relevant clips."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image → Video animation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A still image is generated (via Stability AI) and animated into a short clip."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI video generation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A full video clip is generated from scratch based on the scene script."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can override this default order using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videoSourcesPipeline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, to use only workspace assets and then generate from text, set:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"videoSourcesPipeline\": [\"workspace_assets\", \"generate_from_text\"]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"videoSourcesPipeline\": [\"workspace_assets\", \"generate_from_text\"]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same fallback logic applies to still images in scene overlays, controlled by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imagesSourcePipeline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"projects/createproject/request/missing-images-(togeneratemissingimages)","deepLinkHash":"/projects/createproject#projects/createproject/request/missing-images-(togeneratemissingimages)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing Images ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toGenerateMissingImages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scene templates can have image slots in their dynamic values. If you don't fill those slots:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toGenerateMissingImages: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Shuffll generates a contextually relevant image using Stability AI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toGenerateMissingImages: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → The slot is left empty (scene renders without the image)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"projects/createproject/request/ai-presenter-(avatar)","deepLinkHash":"/projects/createproject#projects/createproject/request/ai-presenter-(avatar)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Presenter (Avatar)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiAvatarSettings.avatarId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use an AI avatar presenter in the video. Get available avatars from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/ai_avatar_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"projects/createproject/request/webhooks","deepLinkHash":"/projects/createproject#projects/createproject/request/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a URL that Shuffll will call when the export completes. The payload sent to your URL will be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"type\": \"export\",\n  \"payload\": {\n    \"projectId\": \"...\",\n    \"projectName\": \"...\",\n    \"urls\": { \"uploadPath\": \"...\", \"dashPath\": \"...\" },\n    \"additionalParams\": { }\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"type\": \"export\",\n  \"payload\": {\n    \"projectId\": \"...\",\n    \"projectName\": \"...\",\n    \"urls\": { \"uploadPath\": \"...\", \"dashPath\": \"...\" },\n    \"additionalParams\": { }\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalParams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed any custom data (IDs, metadata) you want returned in the webhook payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAutoEnhance: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toAutoExport: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fully automate the pipeline: create → enhance → export → webhook, with no polling required."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"projects/createproject/request/after-creating-a-project","deepLinkHash":"/projects/createproject#projects/createproject/request/after-creating-a-project"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After creating a project"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project creation is asynchronous. Poll "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/project/{projectId}/create/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the project is ready."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhancement runs automatically. Monitor progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/project/{projectId}/edit/status/enhance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enhancement is complete, trigger export with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /auth/project/{projectId}/edit/export"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProjectRequest","exampleIds":["paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example"]}},"schemaId":"components/schemas/CreateProjectRequest","exampleIds":["paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example"],"pointer":"/paths/~1auth~1project~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/project/create","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProjectRequest","exampleIds":["paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example"]}},"responseCodes":["200","400","401"],"pointer":"/auth/project/create","href":"projects/createproject","openApiOperationId":"createProject","summary":"Create project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"schemaId":"components/schemas/CreateProjectRequest","exampleIds":["paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProjectRequest","exampleIds":["paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project created successfully. Returns the project ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectCreateResponse","exampleIds":["paths/~1auth~1project~1create/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectCreateResponse","exampleIds":["paths/~1auth~1project~1create/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectCreateResponse","exampleIds":["paths/~1auth~1project~1create/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectCreateResponse","exampleIds":["paths/~1auth~1project~1create/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/createproject"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectCreateStatus","name":"Get project creation status","isWebhook":false,"pointer":"/paths/~1auth~1project~1{projectId}~1create~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get project creation status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll this endpoint after creating a project to track AI generation progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with one of three values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRUCTURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AI is building the storyline and script"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERATING_IMAGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scene visuals and media are being generated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project creation is complete — enhancement will begin automatically"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep polling until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After that, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/project/{projectId}/edit/status/enhance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to track enhancement progress."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_17","description":"Unique identifier for the project","required":true}],"pointer":"/paths/~1auth~1project~1{projectId}~1create~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/project/{projectId}/create/status","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"dad4bce8-f5cb-4078-a211-995864315e39","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/auth/project/{projectId}/create/status","href":"projects/getprojectcreatestatus","openApiOperationId":"getProjectCreateStatus","summary":"Get project creation status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectCreateStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/done","paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/in_progress"]}},"schemaId":"components/schemas/ProjectCreateStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/done","paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/in_progress"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1{projectId}~1create~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectCreateStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/done","paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/in_progress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectCreateStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/done","paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/in_progress"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/getprojectcreatestatus"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectById","name":"Get project","isWebhook":false,"pointer":"/paths/~1auth~1project~1{projectId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the full details of a specific project, including its current status, name, and workspace."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to determine if the project is still being generated:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STRUCTURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — initial structure is being built"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERATING_IMAGES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — images and media are being generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EDITING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — enhancement is running automatically"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — project is ready"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_17","description":"Unique identifier for the project","required":true}],"pointer":"/paths/~1auth~1project~1{projectId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/project/{projectId}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"dad4bce8-f5cb-4078-a211-995864315e39","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/project/{projectId}","href":"projects/getprojectbyid","openApiOperationId":"getProjectById","summary":"Get project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved project details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectDetail","exampleIds":["paths/~1auth~1project~1{projectId}/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectDetail","exampleIds":["paths/~1auth~1project~1{projectId}/get/responses/200/content/application~1json/examples/default_example"]},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1{projectId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectDetail","exampleIds":["paths/~1auth~1project~1{projectId}/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectDetail","exampleIds":["paths/~1auth~1project~1{projectId}/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/getprojectbyid"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProject","name":"Delete project","isWebhook":false,"pointer":"/paths/~1auth~1project~1{projectId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a project and all associated data.\n\nThis action cannot be undone.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_17","description":"Unique identifier for the project","required":true}],"pointer":"/paths/~1auth~1project~1{projectId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/auth/project/{projectId}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"dad4bce8-f5cb-4078-a211-995864315e39","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/auth/project/{projectId}","href":"projects/deleteproject","openApiOperationId":"deleteProject","summary":"Delete project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Project deleted successfully."},{"code":"401","description":"Unauthorized.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1{projectId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/projects/deleteproject"}],"panels":[]}]},"httpPath":"/auth/project/{projectId}"}],"content":{"contentType":"group","meta":{"name":"Projects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Projects","showPageActions":true},{"nodeType":"markdoc","content":"Create, monitor, and manage AI-generated video projects."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/project/create","summary":"Create project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/projects/createproject","deprecated":false},{"title":"/auth/project/{projectId}/create/status","summary":"Get project creation status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/getprojectcreatestatus","deprecated":false},{"title":"/auth/project/{projectId}","summary":"Get project","prefix":{"name":"get","color":"get"},"badges":[],"link":"/projects/getprojectbyid","deprecated":false},{"title":"/auth/project/{projectId}","summary":"Delete project","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/projects/deleteproject","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnhanceStatus","name":"Get project enhancement status","isWebhook":false,"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get project enhancement status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the progress of the automatic enhancement process for a project."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enhancement starts automatically after a project is created. Poll this endpoint to track progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response means enhancement is still in progress — continue polling."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDone: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means enhancement is complete and the project is ready to export."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_17","description":"Unique identifier for the project","required":true}],"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/project/{projectId}/edit/status/enhance","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"dad4bce8-f5cb-4078-a211-995864315e39","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","202","400","404"],"pointer":"/auth/project/{projectId}/edit/status/enhance","href":"enhance/getenhancestatus","openApiOperationId":"getEnhanceStatus","summary":"Get project enhancement status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enhancement complete.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/200/content/application~1json/examples/default_example"]},{"code":"202","description":"Enhancement still in progress.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/202/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/202/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"202","schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/202/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectStatusEnhanceStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/202/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/enhance/getenhancestatus"}],"panels":[]}]},"httpPath":"/auth/project/{projectId}/edit/status/enhance"}],"content":{"contentType":"group","meta":{"name":"Enhance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enhance","showPageActions":true},{"nodeType":"markdoc","content":"Monitor the automatic post-production enhancement process (branding, subtitles, audio cleanup) that runs after a project is created."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/project/{projectId}/edit/status/enhance","summary":"Get project enhancement status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/enhance/getenhancestatus","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportProject","name":"Export project","isWebhook":false,"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1export/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export project","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger the export of a completed project to a video file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projectId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"editId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used to poll the export status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The project must have completed enhancement before exporting."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check enhancement status with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/project/{projectId}/edit/status/enhance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_17","description":"Unique identifier for the project","required":true}],"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1export/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/project/{projectId}/edit/export","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"dad4bce8-f5cb-4078-a211-995864315e39","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/auth/project/{projectId}/edit/export","href":"export/exportproject","openApiOperationId":"exportProject","summary":"Export project"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Export job started successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportTriggerResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1export/post/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ExportTriggerResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1export/post/responses/200/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1export/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExportTriggerResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1export/post/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExportTriggerResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1export/post/responses/200/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/export/exportproject"}],"panels":[]}]},"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExportStatus","name":"Get project export status","isWebhook":false,"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1status~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get project export status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the progress of a project export job."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response means the export is still being processed — continue polling."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isDone: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the export is complete. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object will contain the video file URLs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs returned on completion:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — direct MP4 download URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dashPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — MPEG-DASH streaming manifest URL"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ShuffllApiKey","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"projectId","in":"path","schemaId":"schema_17","description":"Unique identifier for the project","required":true}],"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/auth/project/{projectId}/edit/status/export","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"parameters":{"path":[{"name":"projectId","in":"path","required":true,"example":"dad4bce8-f5cb-4078-a211-995864315e39","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ShuffllApiKey","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","202","400","404"],"pointer":"/auth/project/{projectId}/edit/status/export","href":"export/getexportstatus","openApiOperationId":"getExportStatus","summary":"Get project export status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.shuffll.com/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Export complete.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/200/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/200/content/application~1json/examples/default_example"]},{"code":"202","description":"Export still in progress.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/202/content/application~1json/examples/default_example"]}},"schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/202/content/application~1json/examples/default_example"]},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/200/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/200/content/application~1json/examples/default_example"]}}},{"code":"202","schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/202/content/application~1json/examples/default_example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectExportStatusResponse","exampleIds":["paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/202/content/application~1json/examples/default_example"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/export/getexportstatus"}],"panels":[]}]},"httpPath":"/auth/project/{projectId}/edit/status/export"}],"content":{"contentType":"group","meta":{"name":"Export"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export","showPageActions":true},{"nodeType":"markdoc","content":"Trigger video export and retrieve the final downloadable video URLs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/project/{projectId}/edit/export","summary":"Export project","prefix":{"name":"post","color":"post"},"badges":[],"link":"/export/exportproject","deprecated":false},{"title":"/auth/project/{projectId}/edit/status/export","summary":"Get project export status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/export/getexportstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/StorytellingTechniquesResponse":{"id":"components/schemas/StorytellingTechniquesResponse","kind":"json-schema","title":"StorytellingTechniquesResponse","data":{"description":"Array of available storytelling techniques for video creation","type":"object","properties":{"techniques":{"type":"array","description":"List of storytelling techniques","items":{"$ref":"#/components/schemas/StorytellingTechnique"}}}}},"components/schemas/ToneOfVoiceResponse":{"id":"components/schemas/ToneOfVoiceResponse","kind":"json-schema","title":"ToneOfVoiceResponse","data":{"description":"Array of available tone of voice options for video narration","type":"object","properties":{"tones":{"type":"array","description":"List of tone options","items":{"$ref":"#/components/schemas/ToneOfVoice"}}}}},"components/schemas/VideoTagsResponse":{"id":"components/schemas/VideoTagsResponse","kind":"json-schema","title":"VideoTagsResponse","data":{"description":"Available video category tags","type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/VideoTag"}}}}},"components/schemas/VideoTag":{"id":"components/schemas/VideoTag","kind":"json-schema","title":"VideoTag","data":{"description":"A video category tag","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag identifier — use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videoTagId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project"},"children":[]}]}]}],"example":"Marketing"},"title":{"type":"string","description":"Display title of the tag","example":"Marketing Video"},"text":{"type":"string","description":"Description of the video type","example":"Describe your marketing video"}}}},"components/schemas/AiVoiceOptionsResponse":{"id":"components/schemas/AiVoiceOptionsResponse","kind":"json-schema","title":"AiVoiceOptionsResponse","data":{"description":"Available AI voice options and tone styles","type":"object","properties":{"aiVoiceOptions":{"type":"array","description":"List of available voice-over options","items":{"$ref":"#/components/schemas/AiVoiceOption"}},"aiVoiceTones":{"type":"array","description":"List of tone styles that can be applied to a voice","items":{"$ref":"#/components/schemas/AiVoiceTone"}}}}},"components/schemas/AiVoiceOption":{"id":"components/schemas/AiVoiceOption","kind":"json-schema","title":"AiVoiceOption","data":{"description":"An available AI voice-over option","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice identifier — use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiVoiceSettings.voiceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project"},"children":[]}]}]}],"example":"alloy"},"name":{"type":"string","description":"Internal voice name","example":"alloy"},"title":{"type":"string","description":"Display title of the voice","example":"Alloy"},"subtitle":{"type":"string","description":"Short description of the voice character","example":"Neutral and balanced"},"voiceType":{"type":"string","description":"Voice provider","enum":["open-ai","eleven-labs"],"example":"open-ai"},"tones":{"type":"array","description":"Tone IDs supported by this voice","items":{"type":"string"},"example":["friendly","professional"]}}}},"components/schemas/AiVoiceTone":{"id":"components/schemas/AiVoiceTone","kind":"json-schema","title":"AiVoiceTone","data":{"description":"A tone style applied to an AI voice","type":"object","properties":{"id":{"type":"string","description":"Tone identifier","example":"friendly"},"title":{"type":"string","description":"Display name of the tone","example":"Friendly"},"instructions":{"type":"string","description":"Style instructions passed to the voice model","example":"Speak in a warm, approachable manner"}}}},"components/schemas/AiAvatarOptionsResponse":{"id":"components/schemas/AiAvatarOptionsResponse","kind":"json-schema","title":"AiAvatarOptionsResponse","data":{"description":"Available AI avatar presenter options","type":"object","properties":{"aiAvatarOptions":{"type":"array","items":{"$ref":"#/components/schemas/AiAvatarOption"}}}}},"components/schemas/AiAvatarOption":{"id":"components/schemas/AiAvatarOption","kind":"json-schema","title":"AiAvatarOption","data":{"description":"An available AI avatar presenter","type":"object","properties":{"id":{"type":"string","description":"Avatar identifier","example":"avatar_sarah_001"},"name":{"type":"string","description":"Avatar name","example":"Sarah"},"accent":{"type":"string","description":"Avatar's voice accent","example":"American English"},"title":{"type":"string","description":"Display title","example":"Professional Presenter"},"subtitle":{"type":"string","description":"Short description","example":"Confident and clear"},"videoPath":{"type":"string","description":"URL of the avatar preview video","example":"https://content.shuffll.com/avatars/sarah_preview.mp4"},"avatarType":{"type":"string","description":"Avatar rendering type","example":"realistic"}}}},"components/schemas/MusicLibraryResponse":{"id":"components/schemas/MusicLibraryResponse","kind":"json-schema","title":"MusicLibraryResponse","data":{"description":"Available background music tracks","type":"array","items":{"$ref":"#/components/schemas/BgMusicTrack"}}},"components/schemas/BgMusicTrack":{"id":"components/schemas/BgMusicTrack","kind":"json-schema","title":"BgMusicTrack","data":{"description":"A background music track","type":"object","properties":{"id":{"type":"string","description":"Track identifier","example":"track_upbeat_001"},"name":{"type":"string","description":"Track name","example":"Upbeat Corporate"},"relativePath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path to use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customTemplate.preConfigs.bgMusic.path"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project"},"children":[]}]}]}],"example":"/music/upbeat-corporate.mp3"},"image":{"type":"string","description":"Track artwork URL","example":"https://content.shuffll.com/music/upbeat-corporate-cover.jpg"}}}},"components/schemas/OrganizationsResponse":{"id":"components/schemas/OrganizationsResponse","kind":"json-schema","title":"OrganizationsResponse","data":{"description":"Array of available organizations","type":"array","items":{"$ref":"#/components/schemas/OrganizationSummary"}}},"components/schemas/OrganizationSummary":{"id":"components/schemas/OrganizationSummary","kind":"json-schema","title":"OrganizationSummary","data":{"description":"Organization summary with metadata and branding","type":"object","properties":{"id":{"type":"string","description":"Unique organization identifier","example":"693fb82afd8d1c43077ba0fb"},"name":{"type":"string","description":"Organization name","example":"My Organization"},"workspaces":{"type":"array","description":"List of workspaces in this organization","items":{"type":"object","properties":{"id":{"type":"string","description":"Workspace identifier"},"createdAt":{"type":"string","format":"date-time","description":"Workspace creation timestamp"},"isDefaultForUser":{"type":"boolean","description":"Whether this is the user's default workspace"}}}},"branding":{"$ref":"#/components/schemas/UserBranding"},"createdByEmail":{"type":"string","format":"email","description":"Email of organization creator"},"isAllowedToUseOrganization":{"type":"boolean","description":"Whether user can use this organization"},"userCount":{"type":"integer","description":"Number of users in organization"},"isDefaultForUser":{"type":"boolean","description":"Whether this is the user's default organization"}}}},"components/schemas/OrganizationDetail":{"id":"components/schemas/OrganizationDetail","kind":"json-schema","title":"OrganizationDetail","data":{"description":"Detailed organization information with expanded workspace details","type":"object","properties":{"id":{"type":"string","description":"Unique organization identifier","example":"693fb82afd8d1c43077ba0fb"},"name":{"type":"string","description":"Organization name","example":"My Organization"},"workspaces":{"type":"array","description":"List of workspaces with detailed metrics","items":{"$ref":"#/components/schemas/WorkspaceDetail"}},"branding":{"$ref":"#/components/schemas/UserBranding"},"createdByEmail":{"type":"string","format":"email","description":"Email of organization creator"},"userCount":{"type":"integer","description":"Number of users in organization"}}}},"components/schemas/WorkspaceDetail":{"id":"components/schemas/WorkspaceDetail","kind":"json-schema","title":"WorkspaceDetail","data":{"description":"Detailed workspace information with metrics and branding","type":"object","properties":{"id":{"type":"string","description":"Workspace identifier","example":"693fb82afd8d1c43077ba0fe"},"name":{"type":"string","description":"Workspace name","example":"My Workspace"},"assetCount":{"type":"integer","description":"Number of assets in workspace"},"projectCount":{"type":"integer","description":"Number of projects in workspace"},"templateCount":{"type":"integer","description":"Number of templates in workspace"},"userCount":{"type":"integer","description":"Number of users in workspace"},"createdByEmail":{"type":"string","format":"email","description":"Email of workspace creator"},"branding":{"$ref":"#/components/schemas/UserBranding"}}}},"components/schemas/UpdateWorkspaceRequest":{"id":"components/schemas/UpdateWorkspaceRequest","kind":"json-schema","title":"UpdateWorkspaceRequest","data":{"description":"Fields that can be updated on a workspace","type":"object","properties":{"name":{"type":"string","description":"New display name for the workspace","example":"Marketing Team Workspace"}}}},"components/schemas/UpdateBrandingRequest":{"id":"components/schemas/UpdateBrandingRequest","kind":"json-schema","title":"UpdateBrandingRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a single branding property for a workspace or organization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organization.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify the target entity."},"children":[]}]}]}],"type":"object","required":["propertyName","propertyValue"],"properties":{"workspace":{"type":"object","description":"Target workspace. Required if updating workspace branding.","properties":{"id":{"type":"string","description":"Workspace identifier","example":"693fb82afd8d1c43077ba0fe"}}},"organization":{"type":"object","description":"Target organization. Required if updating organization branding (and no workspace is specified).","properties":{"id":{"type":"string","description":"Organization identifier","example":"693fb82afd8d1c43077ba0fb"}}},"propertyName":{"type":"string","description":"The branding property to update","enum":["logo","logoW","colors","company","about","pronunciations","enabled"],"example":"colors"},"propertyValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new value for the property. Shape depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logoW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"colors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ colorPrimary: string, colorSecondary: string, colorExtra: string }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ name: string, domain: string, geoLocation?: string }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"about"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pronunciations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"array"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of pronunciation objects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]}]}],"example":{"colorPrimary":"#1a1a2e","colorSecondary":"#16213e","colorExtra":"#0f3460"}},"socketIdToExclude":{"type":"string","description":"Optional socket ID to exclude from real-time update notifications"}}}},"components/schemas/Asset":{"id":"components/schemas/Asset","kind":"json-schema","title":"Asset","data":{"description":"A media asset stored in a workspace","type":"object","properties":{"_id":{"type":"string","description":"Unique asset identifier","example":"6947b539cc95ea68854bb523"},"displayName":{"type":"string","description":"Display name of the asset","example":"product-demo.mp4"},"uploadPath":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CDN URL of the asset file. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videosToAdd[].url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a project."},"children":[]}]}]}],"example":"https://content.shuffll.com/workspace/product-demo.mp4"},"dashPath":{"type":"string","description":"MPEG-DASH streaming URL (available for video assets after processing)","example":"https://content.shuffll.com/workspace/product-demo.mpd"},"mimetype":{"type":"string","description":"MIME type of the file","example":"video/mp4"},"type":{"type":"string","description":"Asset category, automatically determined from MIME type","enum":["image","video","audio","pdf","folder"],"example":"video"},"folder":{"type":"string","description":"Folder path the asset belongs to","example":"/"},"userEmail":{"type":"string","format":"email","description":"Email of the user who uploaded the asset","example":"user@example.com"},"createdAt":{"type":"string","format":"date-time","description":"Upload timestamp","example":"2025-12-15T07:26:34.333Z"},"aspectRatio":{"type":"string","description":"Aspect ratio of the asset (for images and videos)","example":"16:9"},"analytics":{"type":"object","description":"AI-generated analysis of the asset content","properties":{"description":{"type":"string","description":"AI-generated description of the asset"},"videoPrompt":{"type":"string","description":"Suggested video prompt based on asset content"},"directions":{"type":"string","description":"Suggested usage directions"},"textHeaderPosition":{"type":"number","description":"Suggested text overlay position"}}}}}},"components/schemas/AssetsListResponse":{"id":"components/schemas/AssetsListResponse","kind":"json-schema","title":"AssetsListResponse","data":{"description":"List of assets in a workspace","type":"array","items":{"$ref":"#/components/schemas/Asset"}}},"components/schemas/UploadAssetsResponse":{"id":"components/schemas/UploadAssetsResponse","kind":"json-schema","title":"UploadAssetsResponse","data":{"description":"Result of a file upload","type":"object","properties":{"uploaded":{"type":"array","description":"Array of successfully uploaded assets","items":{"$ref":"#/components/schemas/Asset"}}}}},"components/schemas/DeleteAssetsRequest":{"id":"components/schemas/DeleteAssetsRequest","kind":"json-schema","title":"DeleteAssetsRequest","data":{"description":"Asset IDs to delete","type":"object","required":["assetIds"],"properties":{"assetIds":{"oneOf":[{"type":"string","description":"Single asset ID"},{"type":"array","items":{"type":"string"},"description":"Array of asset IDs"}],"example":["6947b539cc95ea68854bb523","6947b539cc95ea68854bb524"]}}}},"components/schemas/CreateFolderRequest":{"id":"components/schemas/CreateFolderRequest","kind":"json-schema","title":"CreateFolderRequest","data":{"description":"Name for the new folder","type":"object","required":["newName"],"properties":{"newName":{"type":"string","description":"Folder name (must be unique in the workspace)","example":"Campaign Assets"}}}},"components/schemas/MoveAssetsRequest":{"id":"components/schemas/MoveAssetsRequest","kind":"json-schema","title":"MoveAssetsRequest","data":{"description":"Move assets to a different folder","type":"object","required":["toFolder","assetIds"],"properties":{"toFolder":{"type":"string","description":"Target folder path to move the assets into","example":"/Campaign Assets"},"assetIds":{"oneOf":[{"type":"string","description":"Single asset ID"},{"type":"array","items":{"type":"string"},"description":"Array of asset IDs"}],"example":["6947b539cc95ea68854bb523"]}}}},"components/schemas/RenameAssetRequest":{"id":"components/schemas/RenameAssetRequest","kind":"json-schema","title":"RenameAssetRequest","data":{"description":"New name for the asset","type":"object","required":["newName"],"properties":{"newName":{"type":"string","description":"New display name for the asset","example":"final-product-demo.mp4"}}}},"components/schemas/TemplatesResponse":{"id":"components/schemas/TemplatesResponse","kind":"json-schema","title":"TemplatesResponse","data":{"description":"Array of available templates","type":"array","items":{"$ref":"#/components/schemas/TemplateSummary"}}},"components/schemas/TemplateSummary":{"id":"components/schemas/TemplateSummary","kind":"json-schema","title":"TemplateSummary","data":{"description":"Template summary information","type":"object","properties":{"id":{"type":"string","description":"Unique template identifier","example":"6945258969368fe55125c4b9"},"description":{"type":"string","description":"Template description","example":"A template for new product demo videos"},"name":{"type":"string","description":"Template name","example":"Product Demo Template"}}}},"components/schemas/TemplateDetail":{"id":"components/schemas/TemplateDetail","kind":"json-schema","title":"TemplateDetail","data":{"description":"Detailed template information with scenes and dynamic fields","type":"object","properties":{"id":{"type":"string","description":"Unique template identifier","example":"6945258969368fe55125c4b9"},"description":{"type":"string","description":"Template description","example":"This is a sample template about how useful trees are"},"name":{"type":"string","description":"Template name","example":"Trees for Kids - Template"},"scenes":{"type":"array","description":"Array of scenes in the template","items":{"$ref":"#/components/schemas/TemplateScene"}}}}},"components/schemas/TemplateScene":{"id":"components/schemas/TemplateScene","kind":"json-schema","title":"TemplateScene","data":{"description":"Individual scene within a template","type":"object","properties":{"id":{"type":"string","description":"Unique scene identifier","example":"a517722a-582b-4f8c-bb8f-c8e8014cf6cc"},"type":{"type":"string","description":"Type of scene","example":"headline_txt"},"dynamicValues":{"type":"array","description":"Array of dynamic values that can be customized for this scene","items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of dynamic value (e.g., color_fill, header, image, logo, etc.)"},"children":[]}]}]}],"example":"color_fill"},"position":{"type":"integer","description":"Position index for the dynamic value","example":201}}}},"name":{"type":"string","description":"Scene name or title","example":"Amazing Tree Discovery"},"availableStagePositions":{"type":"array","description":"Available stage positions for this scene","items":{"type":"object","properties":{"id":{"type":"string","description":"Stage position identifier","example":"default"},"position":{"type":"integer","description":"Position value","example":100},"x":{"type":"integer","description":"X coordinate","example":0},"y":{"type":"integer","description":"Y coordinate","example":0},"height":{"type":"integer","description":"Height value","example":0},"width":{"type":"integer","description":"Width value","example":0}}}}}}},"components/schemas/CreateProjectRequest":{"id":"components/schemas/CreateProjectRequest","kind":"json-schema","title":"CreateProjectRequest","data":{"description":"Request payload for creating a new video project.\n\nProjects must always start from a prompt. You can optionally use a template and customize various aspects of the video generation.\n","type":"object","properties":{"prompt":{"type":"string","description":"The content/topic for your video","example":"Explore Riot Games' Innovative Player Experiences"},"promptType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How Shuffll should interpret the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prompt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prompt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Free-text topic description (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A public URL; Shuffll scrapes the page content"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Docs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A Google Docs URL; Shuffll reads the document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Slides"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A Google Slides URL; Shuffll reads the slides"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Script"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — A fully written script; AI script generation is skipped"},"children":[]}]}]}]}],"enum":["Prompt","Link","Docs","Slides","Script"],"example":"Prompt"},"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language for the video script and voiceover."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to detect the language automatically from the prompt text."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}],"enum":["auto","en","es","fr","zh","iw"],"example":"en"},"videoLength":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target video duration in minutes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → ~30 sec · "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → ~1 min · "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → ~2 min · "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → ~3 min"},"children":[]}]}]}],"enum":[0.5,1,2,3],"example":2},"storyTellingTechnique":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storytelling structure for the script. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"technique"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/storytelling_techniques"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"The Before-and-After Transformation"},"toneOfVoice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Narration tone. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/tone_of_voice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Natural","Professional","Informative","Inspirational","Energetic"],"example":"Professional"},"videoTagId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Video category. Guides the AI when writing the script and selecting media."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/video_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"explainer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if omitted."},"children":[]}]}]}],"example":"Marketing"},"webhook":{"type":"string","format":"uri","description":"URL to POST to when the project export completes.\nSee the endpoint description for the full webhook payload format.\n","example":"https://your-app.com/hooks/shuffll-export"},"additionalParams":{"type":"object","description":"Arbitrary data to embed in the webhook payload (e.g., campaign ID, user ID).","example":{"campaignId":"camp_123","userId":"usr_456"}},"toAutoEnhance":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically start enhancement after project creation completes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for integration API requests."},"children":[]}]}]}],"example":true},"toAutoExport":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically start export after enhancement completes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Combine with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive the result with no polling required."},"children":[]}]}]}],"example":false},"aiVoiceSettings":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI voiceover configuration. Get available voices from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/ai_voice_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"voiceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice identifier. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/ai_voice_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"alloy"},"voiceType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voice provider. Must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"voiceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the chosen voice."},"children":[]}]}]}],"enum":["open-ai","eleven-labs"],"example":"open-ai"},"voiceSpeed":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Playback speed multiplier (0.7–1.2). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is normal speed."},"children":[]}]}]}],"minimum":0.7,"maximum":1.2,"example":1},"voiceInstructions":{"type":"string","description":"Custom style instructions for the voice model (OpenAI voices only).\nOverrides the global tone setting for fine-grained voice control.\n","example":"Speak slowly and clearly, with a warm and encouraging tone."}}},"aiAvatarSettings":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI avatar presenter configuration. When set, an AI avatar appears on screen as the video presenter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get available avatars from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/ai_avatar_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"avatarId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Avatar identifier. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/ai_avatar_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"avatar_sarah_001"},"aiVoiceId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override the avatar's default voice with a specific voice ID from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/ai_voice_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"alloy"}}},"videoSourcesPipeline":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override the default order in which Shuffll sources media for each scene."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sources are tried in order; the first one that yields results is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default order:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"stock_footage\", \"workspace_assets\", \"generate_from_image\", \"generate_from_text\"]"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stock_footage"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search stock video libraries"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_assets"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use videos from your workspace asset library"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generate_from_image"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a still image (Stability AI) then animate it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generate_from_text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a full video clip from scratch using generative AI"},"children":[]}]}]}]}]}]}],"items":{"type":"string","enum":["stock_footage","workspace_assets","generate_from_image","generate_from_text"]},"example":["workspace_assets","stock_footage"]},"imagesSourcePipeline":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override the default order for sourcing still images used in scene overlays and graphics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default order:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"stock_footage\", \"generate_from_text\", \"workspace_assets\"]"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stock_footage"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search stock image libraries"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generate_from_text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate an image using Stability AI"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"workspace_assets"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use images from your workspace asset library"},"children":[]}]}]}]}]}]}],"items":{"type":"string","enum":["stock_footage","generate_from_text","workspace_assets"]},"example":["workspace_assets","generate_from_text"]},"customTemplate":{"type":"object","description":"Template and scene configuration.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template ID from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit to use the default template."},"children":[]}]}]}]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom description used as the AI system prompt when generating video scripts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overrides the template's stored description regardless of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toUseTemplateDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to provide brand context, tone guidelines, or audience information that shapes the entire script."},"children":[]}]}]}],"example":"Shuffll helps marketing teams create professional videos in minutes. Tone: confident, modern, B2B-focused."},"toUseTemplateDescription":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the template's stored description is used as the AI system prompt."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ignored if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also provided (explicit description always wins)."},"children":[]}]}]}],"example":true},"flexibilityOverride":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how strictly the AI follows the template scene structure."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rigid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Scene order and types are fixed exactly as in the template"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Small adaptations allowed (e.g., skipping an empty scene)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flexible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — AI can freely reorganize or adapt scenes to fit the content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overrides the flexibility setting stored on the template."},"children":[]}]}]}]}],"enum":["rigid","minor","flexible"],"example":"flexible"},"assets":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Media assets (images or videos) to make available for the AI to distribute across scenes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each asset in this list is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validated as a reachable image or video URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Analyzed by AI to generate a description and usage context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloaded and stored in your workspace under the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Api Assets\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" folder"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Made available for the AI to intelligently assign to the most relevant scenes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the recommended way to bring your own branded media into a project without pre-assigning clips to specific scenes. For explicit scene-level placement, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenes[].videosToAdd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Publicly accessible URL of the image or video asset.","example":"https://example.com/product-launch.mp4"},"type":{"type":"string","description":"Asset media type. If omitted, Shuffll auto-detects from the URL.","enum":["image","video"],"example":"video"},"description":{"type":"string","description":"Optional human-provided description of the asset. If omitted, Shuffll generates one automatically using AI.\nProviding a description improves the accuracy of scene matching.\n","example":"A 30-second product demo showing the dashboard onboarding flow."},"direction":{"type":"string","description":"Optional guidance on how the asset should be used (e.g., which scenes it fits, what mood it conveys).\n","example":"Use in the opening scene to establish product credibility."},"textHeaderPosition":{"type":"number","description":"Suggested vertical position for text overlays on this asset (percentage from top).","example":20}}}},"videoSourcesByOrder":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override the video media fallback pipeline when using a template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equivalent to the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videoSourcesPipeline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field — use one or the other, not both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, the pipeline configured on the template is used."},"children":[]}]}]}],"items":{"type":"string","enum":["stock_footage","workspace_assets","generate_from_image","generate_from_text"]},"example":["workspace_assets","stock_footage"]},"imageSourcesByOrder":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override the image media fallback pipeline when using a template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equivalent to the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imagesSourcePipeline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field — use one or the other, not both."},"children":[]}]}]}],"items":{"type":"string","enum":["stock_footage","generate_from_text","workspace_assets"]},"example":["workspace_assets","generate_from_text"]},"fontsSettings":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom font configuration for the video. Overrides the template's default fonts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"family"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if provided."},"children":[]}]}]}],"properties":{"primary":{"type":"object","description":"Primary font used for main headings and titles.","properties":{"family":{"type":"string","example":"Arimo"},"weight":{"type":"string","example":"700"}}},"secondary":{"type":"object","description":"Secondary font used for subheadings and body text.","properties":{"family":{"type":"string","example":"Arimo"},"weight":{"type":"string","example":"400"}}},"remaining":{"type":["object","null"],"description":"Font applied to all other text elements not covered by primary or secondary.","properties":{"family":{"type":"string"},"weight":{"type":"string"}}}}},"toUseTemplateFont":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the font settings stored on the template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ignored if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fontsSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is explicitly provided."},"children":[]}]}]}],"example":true},"preConfigs":{"type":"object","description":"Global settings applied across all scenes.","properties":{"bgMusic":{"type":"object","description":"Background music settings.","properties":{"volume":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Music volume relative to voiceover (0–1). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a common value for subtle background music."},"children":[]}]}]}],"minimum":0,"maximum":1,"example":0.3},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track path from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/config/music-library"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relativePath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field)."},"children":[]}]}]}],"example":"/music/upbeat-corporate.mp3"}}},"toCleanAudio":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically remove background noise from audio in user-uploaded videos."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended when your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"videosToAdd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clips contain ambient noise."},"children":[]}]}]}],"example":false},"aiGenerationStability":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creativity vs. accuracy tradeoff for AI image generation (0–1)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower = more creative/varied; higher = closer to the prompt."},"children":[]}]}]}],"minimum":0,"maximum":1,"example":0.5},"subtitles":{"type":"object","description":"Subtitle appearance settings.","properties":{"percentOffset":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vertical position from the bottom as a percentage (1–100)."},"children":[]}]}]}],"minimum":1,"maximum":100},"textSize":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font size in points (8–48)."},"children":[]}]}]}],"minimum":8,"maximum":48},"strategy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How text is revealed as it is spoken."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_UTTERANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Full sentence appears at once"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WORD_BY_WORD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — One word at a time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KARAOKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Words highlight progressively"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WORD_HIGHLIGHT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active word is highlighted"},"children":[]}]}]}]}],"enum":["FULL_UTTERANCE","WORD_BY_WORD","KARAOKE","WORD_HIGHLIGHT"]},"fontName":{"type":"string","description":"Subtitle font name."},"isBold":{"type":"boolean","description":"Bold subtitle text."},"primaryColour":{"type":"string","description":"Primary text color (hex).","example":"#FFFFFF"},"secondaryColour":{"type":"string","description":"Shadow/secondary text color (hex).","example":"#000000"},"outlineColour":{"type":"string","description":"Text outline color (hex).","example":"#000000"},"styles":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fine-grained style overrides for normal and highlighted subtitle states."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KARAOKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WORD_HIGHLIGHT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" strategies to style the active word differently."},"children":[]}]}]}],"properties":{"normal":{"type":"object","description":"Style for words that are not currently being spoken.","properties":{"color":{"type":"string","description":"Text color (hex).","example":"#FFFFFF"},"fontSize":{"type":"number","description":"Font size override for normal words."}}},"highlight":{"type":"object","description":"Style for the word currently being spoken.","properties":{"color":{"type":"string","description":"Highlight text color (hex).","example":"#FFD700"},"fontSize":{"type":"number","description":"Font size override for the highlighted word."}}}}}}}}},"scenes":{"type":"array","description":"Per-scene overrides. Only include scenes you want to customize.\nScenes not listed here are auto-generated using the template and your workspace branding.\n","items":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scene ID from the template. Get scene IDs from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/templates/{templateId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"staticScript":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Force a fixed voiceover script for this scene, bypassing AI generation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To render the scene with no voiceover at all, provide a single space "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\" \""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"moreDetailsAboutScene":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extra guidance for the AI when writing this scene's script."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Open with a bold statistic about player retention.\""},"children":[]}]}]}]},"toGenerateMissingImages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", any image slots in this scene's template layout that are not provided in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dynamicValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be auto-generated using Stability AI."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default), unfilled image slots are left empty."},"children":[]}]}]}],"example":true},"toUseSubtitles":{"type":"boolean","description":"Enable or disable subtitles for this scene. Overrides the global subtitle setting."},"toMakeVOAsMasterInDefault":{"type":"boolean","description":"Make the AI voiceover the master audio track, taking priority over any video audio."},"wordBoost":{"type":"array","items":{"type":"string"},"description":"Words to boost in speech recognition transcription for this scene.\nUse this for product names, brand names, or uncommon terms that the transcription model might mis-hear.\n","example":["Shuffll","MPEG-DASH","Riot Games"]},"customSpelling":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom spelling corrections for the subtitle transcript of this scene."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each entry maps a list of heard variations ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to the correct spelling ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful when the AI voiceover or transcription produces a slightly wrong spelling of a proper noun."},"children":[]}]}]}],"items":{"type":"object","required":["from","to"],"properties":{"from":{"type":"array","items":{"type":"string"},"description":"Incorrect or alternative spellings to replace.","example":["Shuffel","Shufflle"]},"to":{"type":"string","description":"The correct spelling.","example":"Shuffll"}}}},"staticText":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed text values to display in this scene's text elements, used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toUseStaticText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provided in order — each string maps to a text element in the scene layout."},"children":[]}]}]}],"example":["Your headline here","Supporting detail line"]},"toUseStaticText":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the strings in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staticText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the scene's on-screen text instead of AI-generated content."},"children":[]}]}]}]},"punctuationsToRemove":{"type":"array","items":{"type":"string"},"description":"Punctuation marks to strip from the subtitle text for this scene.","example":[",",".","!"]},"dynamicValues":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override specific visual elements in the scene (text, colors, images, logos)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the available element types and positions from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/templates/{templateId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"topic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color_fill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"position":{"type":"number","description":"Element position index (from the template definition)."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Element type (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color_fill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"value":{"type":"string","description":"The value to set for this element."}}},"example":[{"position":0,"type":"header","value":"Innovating Player Experience"},{"position":0,"type":"logo","value":"https://example.com/logo.png"},{"position":0,"type":"website","value":"https://riotgames.com"}]},"videosToAdd":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Videos to place in this scene. These bypass the media fallback pipeline entirely — provided videos are always used first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/workspace/{workspaceId}/assets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference a workspace asset, or provide any publicly accessible URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stagePositionNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to target a specific layout slot within the scene. Available positions come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableStagePositions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/templates/{templateId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public video URL. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /auth/workspace/{workspaceId}/assets"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference a workspace asset."},"children":[]}]}]}],"example":"https://content.shuffll.com/workspace/product-demo.mp4"},"stagePositionNumber":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layout slot to place this video in. Corresponds to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"availableStagePositions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the default (highest available) position."},"children":[]}]}]}],"example":100},"isMaster":{"type":"boolean","description":"Marks this as the primary video layer for the scene.\nThe master video drives timing and is synced with voiceover and subtitles.\nOnly one video per scene can be master. If none is marked, the longest video is chosen automatically.\n"},"isMuted":{"type":"boolean","description":"Mute this video's audio (voiceover will still play over it)."},"toFlip":{"type":"boolean","description":"Mirror the video horizontally."},"toAutoTrim":{"type":["boolean","null"],"description":"Automatically trim the video to match the scene duration."},"toUseSubtitles":{"type":"boolean","description":"Use this video's own subtitles/audio instead of the AI voiceover for this scene."},"toGenerateSubtitles":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate subtitles by transcribing this video's audio track."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toUseSubtitles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this transcribes the video's own speech rather than using the AI voiceover."},"children":[]}]}]}]}}}}}}},"toReturnAnErrorIfMissingScene":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error if a scene ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scenes[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not exist in the template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default), unrecognized scenes are silently skipped."},"children":[]}]}]}]}}}},"required":["prompt"]}},"components/schemas/ProjectCreateResponse":{"id":"components/schemas/ProjectCreateResponse","kind":"json-schema","title":"ProjectCreateResponse","data":{"description":"Response returned when a project is successfully created.","type":"object","properties":{"projectId":{"type":"string","description":"Unique identifier for the created project","example":"6947b539cc95ea68854bb523"}}}},"components/schemas/ProjectCreateStatusResponse":{"id":"components/schemas/ProjectCreateStatusResponse","kind":"json-schema","title":"ProjectCreateStatusResponse","data":{"description":"Response from the project creation status endpoint.","type":"object","properties":{"status":{"type":"string","description":"Current creation stage of the project","enum":["STRUCTURE","GENERATING_IMAGES","DONE"],"example":"DONE"}}}},"components/schemas/ProjectDetail":{"id":"components/schemas/ProjectDetail","kind":"json-schema","title":"ProjectDetail","data":{"description":"Detailed information about a project","type":"object","properties":{"id":{"type":"string","description":"Unique project identifier","example":"6947b539cc95ea68854bb523"},"name":{"type":"string","description":"Project name","example":"Breaking the Agency Mold"},"status":{"type":"string","description":"Current project status","enum":["STRUCTURE","GENERATING_IMAGES","EDITING","DONE"],"example":"DONE"},"createdAt":{"type":"string","format":"date-time","description":"Project creation timestamp","example":"2025-12-15T07:26:34.333Z"},"workspaceId":{"type":"string","description":"ID of the workspace this project belongs to","example":"693fb82afd8d1c43077ba0fe"}}}},"components/schemas/ProjectSummary":{"id":"components/schemas/ProjectSummary","kind":"json-schema","title":"ProjectSummary","data":{"description":"Brief project summary for list views","type":"object","properties":{"id":{"type":"string","description":"Unique project identifier","example":"6947b539cc95ea68854bb523"},"name":{"type":"string","description":"Project name","example":"Breaking the Agency Mold"},"status":{"type":"string","description":"Current project status","enum":["STRUCTURE","GENERATING_IMAGES","EDITING","DONE"],"example":"DONE"},"createdAt":{"type":"string","format":"date-time","description":"Project creation timestamp","example":"2025-12-15T07:26:34.333Z"}}}},"components/schemas/ProjectsListResponse":{"id":"components/schemas/ProjectsListResponse","kind":"json-schema","title":"ProjectsListResponse","data":{"description":"List of projects in a workspace","type":"array","items":{"$ref":"#/components/schemas/ProjectSummary"}}},"components/schemas/ProjectStatusEnhanceStatusResponse":{"id":"components/schemas/ProjectStatusEnhanceStatusResponse","kind":"json-schema","title":"ProjectStatusEnhanceStatusResponse","data":{"description":"Enhancement progress status","type":"object","properties":{"percentages":{"$ref":"#/components/schemas/Percentages"},"isDone":{"$ref":"#/components/schemas/isDone"}}}},"components/schemas/ExportTriggerResponse":{"id":"components/schemas/ExportTriggerResponse","kind":"json-schema","title":"ExportTriggerResponse","data":{"description":"Response returned when an export job is initiated","type":"object","properties":{"projectId":{"type":"string","description":"Unique identifier of the project being exported","example":"3be6453c-03eb-4357-ae5a-984a0e574a54"},"editId":{"type":"string","description":"Unique identifier of the edit created for this export job","example":"2f14374a-9c65-4ee5-94b7-fba66d893483"}}}},"components/schemas/ProjectExportStatusResponse":{"id":"components/schemas/ProjectExportStatusResponse","kind":"json-schema","title":"ProjectExportStatusResponse","data":{"description":"Export progress status and download URLs","type":"object","properties":{"isDone":{"$ref":"#/components/schemas/isDone"},"urls":{"$ref":"#/components/schemas/Urls"}}}},"components/schemas/ToneOfVoice":{"id":"components/schemas/ToneOfVoice","kind":"json-schema","title":"ToneOfVoice","data":{"description":"Individual tone of voice option","type":"object","properties":{"id":{"type":"string","description":"Tone identifier","example":"Natural"},"description":{"type":"string","description":"Description of the tone","example":"Clear and simple to understand."}}}},"components/schemas/StorytellingTechnique":{"id":"components/schemas/StorytellingTechnique","kind":"json-schema","title":"StorytellingTechnique","data":{"description":"Individual storytelling technique with details","type":"object","properties":{"technique":{"type":"string","description":"Name of the storytelling technique","example":"The Relatable Problem"},"description":{"type":"string","description":"Detailed description of the technique","example":"Start by describing a problem that your audience can relate to."},"whyItWorks":{"type":"string","description":"Explanation of why this technique is effective","example":"It immediately captures attention by addressing a pain point."},"example":{"type":"string","description":"Example usage of the technique","example":"Ever feel like you're wasting hours on [insert task] and getting nowhere? That's exactly where I was a year ago."}}}},"components/schemas/UserBranding":{"id":"components/schemas/UserBranding","kind":"json-schema","title":"UserBranding","data":{"description":"User's branding configuration for video creation","type":"object","properties":{"company":{"type":"object","description":"Company information","properties":{"id":{"type":"string","description":"Company identifier","example":"shuffll"},"domain":{"type":"string","description":"Company domain","example":""},"geoLocation":{"type":["string","null"],"description":"Geographic location of company"},"minSize":{"type":["integer","null"],"description":"Minimum company size"},"maxSize":{"type":["integer","null"],"description":"Maximum company size"},"name":{"type":"string","description":"Company name","example":""}}},"isDefault":{"type":"boolean","description":"Whether using default branding settings","example":true},"enabled":{"type":"boolean","description":"Whether branding is enabled","example":true},"logo":{"type":"string","description":"Path to company logo","example":"/files/platform/onboarding/logo-placeholder.svg"},"logoW":{"type":"string","description":"Path to white version of logo","example":"/files/platform/onboarding/logo-placeholder.svg"},"colors":{"type":"object","description":"Brand color palette","properties":{"colorPrimary":{"type":"string","description":"Primary brand color (hex)","example":"#99b898"},"colorSecondary":{"type":"string","description":"Secondary brand color (hex)","example":"#feceab"},"colorExtra":{"type":"string","description":"Extra/accent brand color (hex)","example":"#ff847c"},"_id":{"type":"string","description":"Internal color palette identifier"}}},"prompts":{"type":"array","description":"User's saved prompts with tags and suggestions","items":{"type":"object","properties":{"tag":{"type":"object","properties":{"title":{"type":"string","description":"Prompt category title","example":"Thought Leadership Video"},"id":{"type":"string","description":"Prompt category ID","example":"Thought leadership"},"text":{"type":"string","description":"Prompt description text","example":"Describe your Thought leadership video"}}},"suggestions":{"type":"array","description":"Suggested prompts for this category","items":{"type":"string","example":"Exploring Unconventional Solutions for Team Innovation"}}}}},"about":{"type":"string","description":"Company description used by AI when writing video scripts","example":"Acme Corp builds innovative solutions for enterprise teams."},"videoIdeas":{"type":"array","description":"AI-generated video idea suggestions for the workspace","items":{"type":"object","properties":{"shortTitle":{"type":"string"},"prompt":{"type":"string"},"designId":{"type":"string"},"designGroupId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}},"videoIdeaStatus":{"type":"string","description":"Status of the video idea generation","example":"COMPLETED"},"pronunciations":{"type":"array","description":"Custom pronunciation settings for brand, people, and product names in AI voiceovers","items":{"type":"object"}}}}},"components/schemas/Percentages":{"id":"components/schemas/Percentages","kind":"json-schema","title":"Percentages","data":{"description":"Completion percentage","type":"number","example":100}},"components/schemas/isDone":{"id":"components/schemas/isDone","kind":"json-schema","title":"isDone","data":{"description":"Whether the operation is complete","type":"boolean","example":true}},"components/schemas/Urls":{"id":"components/schemas/Urls","kind":"json-schema","title":"Urls","data":{"description":"Video output URLs","type":"object","properties":{"uploadPath":{"$ref":"#/components/schemas/UploadPath"},"dashPath":{"$ref":"#/components/schemas/DashPath"}}}},"components/schemas/UploadPath":{"id":"components/schemas/UploadPath","kind":"json-schema","title":"UploadPath","data":{"type":"string","description":"Direct MP4 download URL","example":"https://content.shuffll.com/exports/project.mp4"}},"components/schemas/DashPath":{"id":"components/schemas/DashPath","kind":"json-schema","title":"DashPath","data":{"type":"string","description":"MPEG-DASH streaming manifest URL","example":"https://content.shuffll.com/exports/project.mpd"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"type":{"type":"string","example":"object"},"title":{"type":"string","example":"Validation failed"},"message":{"type":"string","example":"Bad Request"}}}},"schema_9":{"kind":"json-schema","data":{"type":"string","example":"693fb82afd8d1c43077ba0fb"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","example":"693fb82afd8d1c43077ba0fe"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","enum":["image","video","audio","pdf"],"example":"video"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","example":"/"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file to upload. Supported types — images (JPEG, PNG, GIF, WebP, SVG), videos (MP4, MOV, WebM), audio (MP3, WAV, OGG), and PDFs."},"children":[]}]}]}]}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"string","example":"6947b539cc95ea68854bb523"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","example":"67682e831de738f85b0d0fc9"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"dad4bce8-f5cb-4078-a211-995864315e39"},"id":"schema_17"}},"exampleStore":{"components/examples/StorytellingTechniquesResponseExample":{"id":"components/examples/StorytellingTechniquesResponseExample","value":{"techniques":[{"technique":"The Relatable Problem","description":"Start by describing a problem that your audience can relate to.","whyItWorks":"It immediately captures attention by addressing a pain point.","example":"Ever feel like you're wasting hours on [insert task] and getting nowhere? That's exactly where I was a year ago."},{"technique":"The Before-and-After Transformation","description":"Show a contrast between 'how things were' and 'how things are now.'","whyItWorks":"People love transformation stories because they're inspiring and aspirational.","example":"A year ago, I was struggling to get leads. Fast forward to today, I've tripled my ROI using this one strategy."},{"technique":"The Hero's Journey","description":"Use a classic storytelling arc: challenge, struggle, solution, success.","whyItWorks":"It positions you as a guide helping your audience become the hero of their own story.","example":"I used to think [wrong assumption]. Then I learned [solution], and it completely changed the way I do [task]."},{"technique":"Data-Driven Narrative","description":"Use statistics or facts to ground your story and create credibility.","whyItWorks":"Numbers can be persuasive and make your story feel more impactful.","example":"Did you know 80% of businesses fail because they don't [solution]? Here's how I avoided that and succeeded."},{"technique":"The Obstacle-Reversal","description":"Start with an obstacle you faced, and explain how you flipped it into an opportunity.","whyItWorks":"People are drawn to stories of resilience and creativity.","example":"When my ad budget was cut in half, I thought my campaign was over. But then I discovered this technique, and my engagement skyrocketed."},{"technique":"Customer Success Story","description":"Share the story of a real customer or client.","whyItWorks":"It builds trust and shows that your product or service delivers results.","example":"One of our clients, Sarah, was spending hours editing videos. With our platform, she created professional content in minutes."},{"technique":"The 'What If' Scenario","description":"Paint a picture of a better future or a nightmare avoided.","whyItWorks":"It triggers imagination and emotion, making your message more memorable.","example":"What if you could double your sales in half the time? That's what our software does."},{"technique":"The Open Loop","description":"Start with an intriguing question or incomplete story and finish it later in the video.","whyItWorks":"It keeps viewers hooked because they want to see how the story ends.","example":"I tried 5 strategies to grow my business, and only 1 worked. Let me show you why."},{"technique":"Personal Vulnerability","description":"Share a personal challenge or failure.","whyItWorks":"Authenticity builds trust and connection with your audience.","example":"I almost gave up on [project/task] because I thought I wasn't good enough. Here's what changed everything for me."},{"technique":"Lessons Learned Format","description":"Share a lesson you learned through trial and error.","whyItWorks":"People love learning from others' mistakes or insights.","example":"I wasted $10,000 on ads before I realized what I was doing wrong. Here are the 3 things I learned."},{"technique":"The Challenge","description":"Issue a challenge to your audience.","whyItWorks":"It engages your audience and makes them feel like part of the story.","example":"Here's a challenge: try this strategy for 7 days and tell me if you don't see results."},{"technique":"The 'What Happened Next' Story","description":"Start with a cliffhanger and explain the outcome.","whyItWorks":"Builds suspense and keeps viewers engaged.","example":"I posted this one video, went to bed, and woke up to 10,000 new followers. Here's how it happened."}]},"summary":"List of all storytelling techniques"},"components/examples/ToneOfVoiceResponseExample":{"id":"components/examples/ToneOfVoiceResponseExample","value":{"tones":[{"id":"Natural","description":"Clear and simple to understand."},{"id":"Professional","description":"Formal and credible."},{"id":"Informative","description":"Clear and educational."},{"id":"Inspirational","description":"Motivates and uplifts."},{"id":"Energetic","description":"Lively and exciting."}]},"summary":"List of all tone of voice options"},"components/examples/VideoTagsResponseExample":{"id":"components/examples/VideoTagsResponseExample","value":{"tags":[{"id":"Marketing","title":"Marketing Video","text":"Describe your marketing video"},{"id":"explainer","title":"Explainer Video","text":"Describe your explainer video"},{"id":"Training ","title":"Training Video","text":"Describe your Training video"},{"id":"Product ","title":"Product Video","text":"Describe your Product video"},{"id":"Thought leadership","title":"Thought Leadership Video","text":"Describe your Thought leadership video"}]},"summary":"List of all video category tags"},"components/examples/AiVoiceOptionsResponseExample":{"id":"components/examples/AiVoiceOptionsResponseExample","value":{"aiVoiceOptions":[{"id":"alloy","name":"alloy","title":"Alloy","subtitle":"Neutral and balanced","voiceType":"open-ai","tones":["friendly","professional","calm"]},{"id":"nova","name":"nova","title":"Nova","subtitle":"Warm and engaging","voiceType":"open-ai","tones":["friendly","excited","empathy"]},{"id":"EXAVITQu4vr4xnSDxMaL","name":"bella","title":"Bella","subtitle":"Expressive and versatile","voiceType":"eleven-labs","tones":["professional","dramatic","energetic"]}],"aiVoiceTones":[{"id":"friendly","title":"Friendly","instructions":"Speak in a warm, approachable manner"},{"id":"professional","title":"Professional","instructions":"Maintain a clear, authoritative tone"},{"id":"excited","title":"Excited","instructions":"Speak with high energy and enthusiasm"},{"id":"calm","title":"Calm","instructions":"Speak slowly and soothingly"}]},"summary":"List of AI voice options and tone styles"},"components/examples/AiAvatarOptionsResponseExample":{"id":"components/examples/AiAvatarOptionsResponseExample","value":{"aiAvatarOptions":[{"id":"avatar_sarah_001","name":"Sarah","accent":"American English","title":"Professional Presenter","subtitle":"Confident and clear","videoPath":"https://content.shuffll.com/avatars/sarah_preview.mp4","avatarType":"realistic"},{"id":"avatar_james_002","name":"James","accent":"British English","title":"Executive Speaker","subtitle":"Authoritative and polished","videoPath":"https://content.shuffll.com/avatars/james_preview.mp4","avatarType":"realistic"}]},"summary":"List of available AI avatar presenters"},"components/examples/MusicLibraryResponseExample":{"id":"components/examples/MusicLibraryResponseExample","value":[{"id":"track_upbeat_001","name":"Upbeat Corporate","relativePath":"/music/upbeat-corporate.mp3","image":"https://content.shuffll.com/music/upbeat-corporate-cover.jpg"},{"id":"track_ambient_002","name":"Ambient Focus","relativePath":"/music/ambient-focus.mp3","image":"https://content.shuffll.com/music/ambient-focus-cover.jpg"},{"id":"track_cinematic_003","name":"Cinematic Inspire","relativePath":"/music/cinematic-inspire.mp3","image":"https://content.shuffll.com/music/cinematic-inspire-cover.jpg"}],"summary":"List of available background music tracks"},"components/examples/UpdateWorkspaceRequestExample":{"id":"components/examples/UpdateWorkspaceRequestExample","value":{"name":"Marketing Team Workspace"},"summary":"Rename a workspace"},"components/examples/GetBrandingResponseExample":{"id":"components/examples/GetBrandingResponseExample","value":{"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":[]},"summary":"Branding configuration for a workspace"},"components/examples/UpdateBrandingColorsExample":{"id":"components/examples/UpdateBrandingColorsExample","value":{"workspace":{"id":"693fb82afd8d1c43077ba0fe"},"propertyName":"colors","propertyValue":{"colorPrimary":"#1a1a2e","colorSecondary":"#16213e","colorExtra":"#0f3460"}},"summary":"Update brand colors"},"components/examples/UpdateBrandingLogoExample":{"id":"components/examples/UpdateBrandingLogoExample","value":{"workspace":{"id":"693fb82afd8d1c43077ba0fe"},"propertyName":"logo","propertyValue":"https://content.shuffll.com/branding/acme-logo.png"},"summary":"Update primary logo"},"components/examples/UpdateBrandingCompanyExample":{"id":"components/examples/UpdateBrandingCompanyExample","value":{"workspace":{"id":"693fb82afd8d1c43077ba0fe"},"propertyName":"company","propertyValue":{"name":"Acme Corp","domain":"acme.com","geoLocation":"New York, USA"}},"summary":"Update company information"},"components/examples/AssetsListResponseExample":{"id":"components/examples/AssetsListResponseExample","value":[{"_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"}],"summary":"List of workspace assets"},"components/examples/UploadAssetsResponseExample":{"id":"components/examples/UploadAssetsResponseExample","value":{"uploaded":[{"_id":"6947b539cc95ea68854bb525","displayName":"new-video.mp4","uploadPath":"https://content.shuffll.com/workspace/new-video.mp4","mimetype":"video/mp4","type":"video","folder":"/","userEmail":"user@example.com","createdAt":"2026-02-23T09:00:00.000Z"}]},"summary":"Successfully uploaded file"},"components/examples/DeleteAssetsRequestExample":{"id":"components/examples/DeleteAssetsRequestExample","value":{"assetIds":["6947b539cc95ea68854bb523","6947b539cc95ea68854bb524"]},"summary":"Delete multiple assets"},"components/examples/CreateFolderRequestExample":{"id":"components/examples/CreateFolderRequestExample","value":{"newName":"Campaign Assets"},"summary":"Create a new folder"},"components/examples/MoveAssetsRequestExample":{"id":"components/examples/MoveAssetsRequestExample","value":{"toFolder":"/Campaign Assets","assetIds":["6947b539cc95ea68854bb523"]},"summary":"Move assets into a folder"},"components/examples/RenameAssetRequestExample":{"id":"components/examples/RenameAssetRequestExample","value":{"newName":"final-product-demo.mp4"},"summary":"Rename an asset"},"components/examples/GetOrganizationListResponseExample":{"id":"components/examples/GetOrganizationListResponseExample","value":[{"id":"693fb82afd8d1c43077ba0fb","name":"My Organization","workspaces":[{"id":"693fb82afd8d1c43077ba0fe","createdAt":"2025-12-15T07:26:34.333Z","isDefaultForUser":true}],"branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":"","minSize":null,"maxSize":null,"geoLocation":null},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c","_id":"693fb7e6fd8d1c43077ba0eb"},"prompts":[{"tag":{"title":"Thought Leadership Video","id":"Thought leadership","text":"Describe your Thought leadership video"},"suggestions":["Exploring Unconventional Solutions for Team Innovation","Embracing Sustainable Practices in Everyday Business Operations"]}],"videoIdeas":[{"shortTitle":"Future Trends","prompt":"Anticipating Future Industry Shifts","designId":"66589deee3146a3394628496","designGroupId":"66681ba732c4c63a053f2274","createdAt":"2025-12-18T20:22:42.399Z"}],"videoIdeaStatus":"COMPLETED","pronunciations":[]},"createdByEmail":"info@shuffll.com","isAllowedToUseOrganization":true,"userCount":1,"isDefaultForUser":true}],"summary":"List of all organizations with full details"},"components/examples/GetOrganizationByIdResponseExample":{"id":"components/examples/GetOrganizationByIdResponseExample","value":{"id":"693fb82afd8d1c43077ba0fb","name":"My Organization","workspaces":[{"id":"693fb82afd8d1c43077ba0fe","name":"My Workspace","assetCount":4,"projectCount":3,"userCount":1,"templateCount":1,"createdByEmail":"info@shuffll.com","branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":"","minSize":null,"maxSize":null,"geoLocation":null},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c"}}}],"branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":""},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c"},"pronunciations":[]},"createdByEmail":"info@shuffll.com","userCount":1},"summary":"Detailed organization information with expanded workspace metrics"},"components/examples/GetWorkspaceByIdResponseExample":{"id":"components/examples/GetWorkspaceByIdResponseExample","value":{"id":"693fb82afd8d1c43077ba0fe","name":"My Workspace","assetCount":4,"projectCount":3,"userCount":1,"templateCount":1,"createdByEmail":"info@shuffll.com","branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":"","minSize":null,"maxSize":null,"geoLocation":null},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c"},"pronunciations":[]}},"summary":"Detailed workspace information with metrics and branding"},"components/examples/ListProjectsResponseExample":{"id":"components/examples/ListProjectsResponseExample","value":[{"id":"6947b539cc95ea68854bb523","name":"Breaking the Agency Mold","status":"DONE","createdAt":"2025-12-15T07:26:34.333Z"},{"id":"6947b539cc95ea68854bb524","name":"Product Launch Q1 2026","status":"EDITING","createdAt":"2026-01-10T14:10:00.000Z"},{"id":"6947b539cc95ea68854bb525","name":"Customer Success Stories","status":"GENERATING_IMAGES","createdAt":"2026-02-01T09:00:00.000Z"}],"summary":"List of projects in a workspace"},"components/examples/GetAllTemplatesResponseExample":{"id":"components/examples/GetAllTemplatesResponseExample","value":[{"id":"6945258969368fe55125c4b9","description":"This is a sample template about how useful trees are","name":"Trees for Kids - Template"}],"summary":"List of templates for default organization and workspace"},"components/examples/GetTemplatesByOrgWorkspaceResponseExample":{"id":"components/examples/GetTemplatesByOrgWorkspaceResponseExample","value":[{"id":"6945258969368fe55125c4b9","description":"This is a sample template about how useful trees are","name":"Trees for Kids - Template"}],"summary":"List of templates for specific organization and workspace"},"components/examples/GetTemplateByIdResponseExample":{"id":"components/examples/GetTemplateByIdResponseExample","value":{"id":"6945258969368fe55125c4b9","description":"This is a sample template about how useful trees are","name":"Trees for Kids - Template","scenes":[{"id":"a517722a-582b-4f8c-bb8f-c8e8014cf6cc","type":"headline_txt","dynamicValues":[{"type":"color_fill","position":201},{"type":"color_fill","position":0},{"type":"color_fill","position":100},{"type":"color_fill","position":102},{"type":"header","position":0}],"name":"Amazing Tree Discovery","availableStagePositions":[{"id":"default","position":100,"x":0,"y":0,"height":0,"width":0}]},{"id":"08865dcb-d8f3-4dfd-964d-76304fbbfa9d","type":"img_and_headline_txt","dynamicValues":[{"type":"image","position":0},{"type":"color_fill","position":201},{"type":"color_fill","position":0},{"type":"color_fill","position":100},{"type":"color_fill","position":102},{"type":"header","position":0}],"name":"Tree Parts Explorer","availableStagePositions":[{"id":"default","position":100,"x":0,"y":0,"height":0,"width":0}]},{"id":"00566c97-a41a-45fe-a66c-36a868621297","type":"cta_txt","dynamicValues":[{"type":"logo","position":0},{"type":"color_fill","position":208},{"type":"color_fill","position":100},{"type":"color_fill","position":102},{"type":"website","position":0},{"type":"cta","position":0}],"name":"Nature Explorer Call","availableStagePositions":[{"id":"default","position":100,"x":0,"y":0,"height":0,"width":0}]}]},"summary":"Detailed template information with all scenes"},"components/examples/CreateProjectRequestExample":{"id":"components/examples/CreateProjectRequestExample","value":{"prompt":"Breaking the Agency Mold - Building Long-Term Partnerships with Data","promptType":"Prompt","language":"en","videoLength":2,"toneOfVoice":"Professional","videoTagId":"Marketing","storyTellingTechnique":"The Before-and-After Transformation","toAutoEnhance":true,"toAutoExport":true,"webhook":"https://your-app.com/hooks/shuffll-export","additionalParams":{"campaignId":"camp_123"},"aiVoiceSettings":{"voiceId":"alloy","voiceType":"open-ai","voiceSpeed":1},"customTemplate":{"id":"67682e831de738f85b0d0fc9","description":"Agency-focused video brand. Tone: confident, data-driven, B2B. Audience: marketing directors.","flexibilityOverride":"flexible","toUseTemplateFont":true,"assets":[{"url":"https://example.com/product-demo.mp4","type":"video","description":"60-second product walkthrough showing the analytics dashboard.","direction":"Use in a middle scene to demonstrate product value."},{"url":"https://example.com/team-photo.jpg","type":"image","description":"Company team photo, outdoor setting."}],"videoSourcesByOrder":["workspace_assets","stock_footage","generate_from_image"],"preConfigs":{"bgMusic":{"volume":0.35,"path":"/music/upbeat-corporate.mp3"},"toCleanAudio":false,"subtitles":{"strategy":"WORD_HIGHLIGHT","textSize":18,"percentOffset":40,"fontName":"Arimo","isBold":true,"primaryColour":"#FFFFFF","outlineColour":"#000000","styles":{"normal":{"color":"#FFFFFF"},"highlight":{"color":"#FFD700"}}}},"scenes":[{"id":"a517722a-582b-4f8c-bb8f-c8e8014cf6cc","staticScript":"Data-driven agencies don't just win clients — they keep them for years.","dynamicValues":[{"position":0,"type":"header","value":"Breaking the Agency Mold"},{"position":0,"type":"logo","value":"https://example.com/logo.png"}],"wordBoost":["Shuffll","ROI"],"customSpelling":[{"from":["Shuffel","Shufflle"],"to":"Shuffll"}]},{"id":"08865dcb-d8f3-4dfd-964d-76304fbbfa9d","moreDetailsAboutScene":"Focus on the before/after contrast — struggling agency vs. data-driven success.","toGenerateMissingImages":true,"videosToAdd":[{"url":"https://content.shuffll.com/workspace/agency-intro.mp4","isMaster":true,"stagePositionNumber":100,"isMuted":false,"toAutoTrim":true}]}]}},"summary":"Full-featured project creation with template, assets, and webhook"},"components/examples/CreateProjectResponseExample":{"id":"components/examples/CreateProjectResponseExample","value":{"projectId":"6947b539cc95ea68854bb523"},"summary":"Project created successfully"},"components/examples/GetProjectCreateStatusDoneExample":{"id":"components/examples/GetProjectCreateStatusDoneExample","value":{"status":"DONE"},"summary":"Creation complete"},"components/examples/GetProjectCreateStatusInProgressExample":{"id":"components/examples/GetProjectCreateStatusInProgressExample","value":{"status":"GENERATING_IMAGES"},"summary":"Creation in progress"},"components/examples/GetProjectResponseExample":{"id":"components/examples/GetProjectResponseExample","value":{"id":"6947b539cc95ea68854bb523","name":"Breaking the Agency Mold","status":"DONE","createdAt":"2025-12-15T07:26:34.333Z","workspaceId":"693fb82afd8d1c43077ba0fe"},"summary":"Full project details"},"components/examples/ProjectStatusEnhanceStatusResponseExample":{"id":"components/examples/ProjectStatusEnhanceStatusResponseExample","value":{"percentages":100,"isDone":true},"summary":"Enhancement complete"},"components/examples/ProjectStatusEnhanceStatusStillInProccessResponseExample":{"id":"components/examples/ProjectStatusEnhanceStatusStillInProccessResponseExample","value":{"percentages":50,"isDone":false},"summary":"Enhancement in progress"},"components/examples/ExportTriggerResponseExample":{"id":"components/examples/ExportTriggerResponseExample","value":{"projectId":"3be6453c-03eb-4357-ae5a-984a0e574a54","editId":"2f14374a-9c65-4ee5-94b7-fba66d893483"},"summary":"Export job started"},"components/examples/ProjectExportDoneResponse":{"id":"components/examples/ProjectExportDoneResponse","value":{"isDone":true,"urls":{"uploadPath":"https://content.shuffll.com/exports/project.mp4","dashPath":"https://content.shuffll.com/exports/project.mpd"}},"summary":"Export complete — video URLs available"},"components/examples/ProjectExportStillInProcessResponse":{"id":"components/examples/ProjectExportStillInProcessResponse","value":{"isDone":false,"urls":{}},"summary":"Export still in progress"},"paths/~1auth~1config~1storytelling_techniques/get/responses/200/content/application~1json/examples/default_example":{"value":{"techniques":[{"technique":"The Relatable Problem","description":"Start by describing a problem that your audience can relate to.","whyItWorks":"It immediately captures attention by addressing a pain point.","example":"Ever feel like you're wasting hours on [insert task] and getting nowhere? That's exactly where I was a year ago."},{"technique":"The Before-and-After Transformation","description":"Show a contrast between 'how things were' and 'how things are now.'","whyItWorks":"People love transformation stories because they're inspiring and aspirational.","example":"A year ago, I was struggling to get leads. Fast forward to today, I've tripled my ROI using this one strategy."},{"technique":"The Hero's Journey","description":"Use a classic storytelling arc: challenge, struggle, solution, success.","whyItWorks":"It positions you as a guide helping your audience become the hero of their own story.","example":"I used to think [wrong assumption]. Then I learned [solution], and it completely changed the way I do [task]."},{"technique":"Data-Driven Narrative","description":"Use statistics or facts to ground your story and create credibility.","whyItWorks":"Numbers can be persuasive and make your story feel more impactful.","example":"Did you know 80% of businesses fail because they don't [solution]? Here's how I avoided that and succeeded."},{"technique":"The Obstacle-Reversal","description":"Start with an obstacle you faced, and explain how you flipped it into an opportunity.","whyItWorks":"People are drawn to stories of resilience and creativity.","example":"When my ad budget was cut in half, I thought my campaign was over. But then I discovered this technique, and my engagement skyrocketed."},{"technique":"Customer Success Story","description":"Share the story of a real customer or client.","whyItWorks":"It builds trust and shows that your product or service delivers results.","example":"One of our clients, Sarah, was spending hours editing videos. With our platform, she created professional content in minutes."},{"technique":"The 'What If' Scenario","description":"Paint a picture of a better future or a nightmare avoided.","whyItWorks":"It triggers imagination and emotion, making your message more memorable.","example":"What if you could double your sales in half the time? That's what our software does."},{"technique":"The Open Loop","description":"Start with an intriguing question or incomplete story and finish it later in the video.","whyItWorks":"It keeps viewers hooked because they want to see how the story ends.","example":"I tried 5 strategies to grow my business, and only 1 worked. Let me show you why."},{"technique":"Personal Vulnerability","description":"Share a personal challenge or failure.","whyItWorks":"Authenticity builds trust and connection with your audience.","example":"I almost gave up on [project/task] because I thought I wasn't good enough. Here's what changed everything for me."},{"technique":"Lessons Learned Format","description":"Share a lesson you learned through trial and error.","whyItWorks":"People love learning from others' mistakes or insights.","example":"I wasted $10,000 on ads before I realized what I was doing wrong. Here are the 3 things I learned."},{"technique":"The Challenge","description":"Issue a challenge to your audience.","whyItWorks":"It engages your audience and makes them feel like part of the story.","example":"Here's a challenge: try this strategy for 7 days and tell me if you don't see results."},{"technique":"The 'What Happened Next' Story","description":"Start with a cliffhanger and explain the outcome.","whyItWorks":"Builds suspense and keeps viewers engaged.","example":"I posted this one video, went to bed, and woke up to 10,000 new followers. Here's how it happened."}]},"key":"default_example","summary":"List of all storytelling techniques","id":"paths/~1auth~1config~1storytelling_techniques/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1config~1tone_of_voice/get/responses/200/content/application~1json/examples/default_example":{"value":{"tones":[{"id":"Natural","description":"Clear and simple to understand."},{"id":"Professional","description":"Formal and credible."},{"id":"Informative","description":"Clear and educational."},{"id":"Inspirational","description":"Motivates and uplifts."},{"id":"Energetic","description":"Lively and exciting."}]},"key":"default_example","summary":"List of all tone of voice options","id":"paths/~1auth~1config~1tone_of_voice/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1config~1video_tags/get/responses/200/content/application~1json/examples/default_example":{"value":{"tags":[{"id":"Marketing","title":"Marketing Video","text":"Describe your marketing video"},{"id":"explainer","title":"Explainer Video","text":"Describe your explainer video"},{"id":"Training ","title":"Training Video","text":"Describe your Training video"},{"id":"Product ","title":"Product Video","text":"Describe your Product video"},{"id":"Thought leadership","title":"Thought Leadership Video","text":"Describe your Thought leadership video"}]},"key":"default_example","summary":"List of all video category tags","id":"paths/~1auth~1config~1video_tags/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1config~1ai_voice_options/get/responses/200/content/application~1json/examples/default_example":{"value":{"aiVoiceOptions":[{"id":"alloy","name":"alloy","title":"Alloy","subtitle":"Neutral and balanced","voiceType":"open-ai","tones":["friendly","professional","calm"]},{"id":"nova","name":"nova","title":"Nova","subtitle":"Warm and engaging","voiceType":"open-ai","tones":["friendly","excited","empathy"]},{"id":"EXAVITQu4vr4xnSDxMaL","name":"bella","title":"Bella","subtitle":"Expressive and versatile","voiceType":"eleven-labs","tones":["professional","dramatic","energetic"]}],"aiVoiceTones":[{"id":"friendly","title":"Friendly","instructions":"Speak in a warm, approachable manner"},{"id":"professional","title":"Professional","instructions":"Maintain a clear, authoritative tone"},{"id":"excited","title":"Excited","instructions":"Speak with high energy and enthusiasm"},{"id":"calm","title":"Calm","instructions":"Speak slowly and soothingly"}]},"key":"default_example","summary":"List of AI voice options and tone styles","id":"paths/~1auth~1config~1ai_voice_options/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1config~1ai_avatar_options/get/responses/200/content/application~1json/examples/default_example":{"value":{"aiAvatarOptions":[{"id":"avatar_sarah_001","name":"Sarah","accent":"American English","title":"Professional Presenter","subtitle":"Confident and clear","videoPath":"https://content.shuffll.com/avatars/sarah_preview.mp4","avatarType":"realistic"},{"id":"avatar_james_002","name":"James","accent":"British English","title":"Executive Speaker","subtitle":"Authoritative and polished","videoPath":"https://content.shuffll.com/avatars/james_preview.mp4","avatarType":"realistic"}]},"key":"default_example","summary":"List of available AI avatar presenters","id":"paths/~1auth~1config~1ai_avatar_options/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1config~1music-library/get/responses/200/content/application~1json/examples/default_example":{"value":[{"id":"track_upbeat_001","name":"Upbeat Corporate","relativePath":"/music/upbeat-corporate.mp3","image":"https://content.shuffll.com/music/upbeat-corporate-cover.jpg"},{"id":"track_ambient_002","name":"Ambient Focus","relativePath":"/music/ambient-focus.mp3","image":"https://content.shuffll.com/music/ambient-focus-cover.jpg"},{"id":"track_cinematic_003","name":"Cinematic Inspire","relativePath":"/music/cinematic-inspire.mp3","image":"https://content.shuffll.com/music/cinematic-inspire-cover.jpg"}],"key":"default_example","summary":"List of available background music tracks","id":"paths/~1auth~1config~1music-library/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1organization~1list/get/responses/200/content/application~1json/examples/default_example":{"value":[{"id":"693fb82afd8d1c43077ba0fb","name":"My Organization","workspaces":[{"id":"693fb82afd8d1c43077ba0fe","createdAt":"2025-12-15T07:26:34.333Z","isDefaultForUser":true}],"branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":"","minSize":null,"maxSize":null,"geoLocation":null},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c","_id":"693fb7e6fd8d1c43077ba0eb"},"prompts":[{"tag":{"title":"Thought Leadership Video","id":"Thought leadership","text":"Describe your Thought leadership video"},"suggestions":["Exploring Unconventional Solutions for Team Innovation","Embracing Sustainable Practices in Everyday Business Operations"]}],"videoIdeas":[{"shortTitle":"Future Trends","prompt":"Anticipating Future Industry Shifts","designId":"66589deee3146a3394628496","designGroupId":"66681ba732c4c63a053f2274","createdAt":"2025-12-18T20:22:42.399Z"}],"videoIdeaStatus":"COMPLETED","pronunciations":[]},"createdByEmail":"info@shuffll.com","isAllowedToUseOrganization":true,"userCount":1,"isDefaultForUser":true}],"key":"default_example","summary":"List of all organizations with full details","id":"paths/~1auth~1organization~1list/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1organization~1{organizationId}/get/responses/200/content/application~1json/examples/default_example":{"value":{"id":"693fb82afd8d1c43077ba0fb","name":"My Organization","workspaces":[{"id":"693fb82afd8d1c43077ba0fe","name":"My Workspace","assetCount":4,"projectCount":3,"userCount":1,"templateCount":1,"createdByEmail":"info@shuffll.com","branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":"","minSize":null,"maxSize":null,"geoLocation":null},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c"}}}],"branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":""},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c"},"pronunciations":[]},"createdByEmail":"info@shuffll.com","userCount":1},"key":"default_example","summary":"Detailed organization information with expanded workspace metrics","id":"paths/~1auth~1organization~1{organizationId}/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses/200/content/application~1json/examples/default_example":{"value":{"id":"693fb82afd8d1c43077ba0fe","name":"My Workspace","assetCount":4,"projectCount":3,"userCount":1,"templateCount":1,"createdByEmail":"info@shuffll.com","branding":{"isDefault":true,"enabled":true,"company":{"id":"shuffll","domain":"","name":"","minSize":null,"maxSize":null,"geoLocation":null},"logo":"/files/platform/onboarding/logo-placeholder.svg","logoW":"/files/platform/onboarding/logo-placeholder.svg","colors":{"colorPrimary":"#99b898","colorSecondary":"#feceab","colorExtra":"#ff847c"},"pronunciations":[]}},"key":"default_example","summary":"Detailed workspace information with metrics and branding","id":"paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example":{"value":{"name":"Marketing Team Workspace"},"key":"default_example","summary":"Rename a workspace","id":"paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}/put/requestBody/content/application~1json/examples/default_example"},"paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses/200/content/application~1json/examples/default_example":{"value":[{"id":"6947b539cc95ea68854bb523","name":"Breaking the Agency Mold","status":"DONE","createdAt":"2025-12-15T07:26:34.333Z"},{"id":"6947b539cc95ea68854bb524","name":"Product Launch Q1 2026","status":"EDITING","createdAt":"2026-01-10T14:10:00.000Z"},{"id":"6947b539cc95ea68854bb525","name":"Customer Success Stories","status":"GENERATING_IMAGES","createdAt":"2026-02-01T09:00:00.000Z"}],"key":"default_example","summary":"List of projects in a workspace","id":"paths/~1auth~1workspace~1{workspaceId}~1projects/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1branding~1entity/get/responses/200/content/application~1json/examples/default_example":{"value":{"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":[]},"key":"default_example","summary":"Branding configuration for a workspace","id":"paths/~1auth~1branding~1entity/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors":{"value":{"workspace":{"id":"693fb82afd8d1c43077ba0fe"},"propertyName":"colors","propertyValue":{"colorPrimary":"#1a1a2e","colorSecondary":"#16213e","colorExtra":"#0f3460"}},"key":"update_colors","summary":"Update brand colors","id":"paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_colors"},"paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo":{"value":{"workspace":{"id":"693fb82afd8d1c43077ba0fe"},"propertyName":"logo","propertyValue":"https://content.shuffll.com/branding/acme-logo.png"},"key":"update_logo","summary":"Update primary logo","id":"paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_logo"},"paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company":{"value":{"workspace":{"id":"693fb82afd8d1c43077ba0fe"},"propertyName":"company","propertyValue":{"name":"Acme Corp","domain":"acme.com","geoLocation":"New York, USA"}},"key":"update_company","summary":"Update company information","id":"paths/~1auth~1branding~1entity/put/requestBody/content/application~1json/examples/update_company"},"paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses/200/content/application~1json/examples/default_example":{"value":[{"_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"}],"key":"default_example","summary":"List of workspace assets","id":"paths/~1auth~1workspace~1{workspaceId}~1assets/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses/200/content/application~1json/examples/default_example":{"value":{"uploaded":[{"_id":"6947b539cc95ea68854bb525","displayName":"new-video.mp4","uploadPath":"https://content.shuffll.com/workspace/new-video.mp4","mimetype":"video/mp4","type":"video","folder":"/","userEmail":"user@example.com","createdAt":"2026-02-23T09:00:00.000Z"}]},"key":"default_example","summary":"Successfully uploaded file","id":"paths/~1auth~1workspace~1{workspaceId}~1assets/post/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example":{"value":{"assetIds":["6947b539cc95ea68854bb523","6947b539cc95ea68854bb524"]},"key":"default_example","summary":"Delete multiple assets","id":"paths/~1auth~1workspace~1{workspaceId}~1assets/delete/requestBody/content/application~1json/examples/default_example"},"paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example":{"value":{"newName":"Campaign Assets"},"key":"default_example","summary":"Create a new folder","id":"paths/~1auth~1workspace~1{workspaceId}~1assets~1folder/post/requestBody/content/application~1json/examples/default_example"},"paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example":{"value":{"toFolder":"/Campaign Assets","assetIds":["6947b539cc95ea68854bb523"]},"key":"default_example","summary":"Move assets into a folder","id":"paths/~1auth~1workspace~1{workspaceId}~1assets~1move/put/requestBody/content/application~1json/examples/default_example"},"paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example":{"value":{"newName":"final-product-demo.mp4"},"key":"default_example","summary":"Rename an asset","id":"paths/~1auth~1workspace~1{workspaceId}~1assets~1{assetId}~1file/put/requestBody/content/application~1json/examples/default_example"},"paths/~1auth~1templates/get/responses/200/content/application~1json/examples/default_example":{"value":[{"id":"6945258969368fe55125c4b9","description":"This is a sample template about how useful trees are","name":"Trees for Kids - Template"}],"key":"default_example","summary":"List of templates for default organization and workspace","id":"paths/~1auth~1templates/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses/200/content/application~1json/examples/default_example":{"value":[{"id":"6945258969368fe55125c4b9","description":"This is a sample template about how useful trees are","name":"Trees for Kids - Template"}],"key":"default_example","summary":"List of templates for specific organization and workspace","id":"paths/~1auth~1organization~1{organizationId}~1workspace~1{workspaceId}~1templates/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1templates~1{templateId}/get/responses/200/content/application~1json/examples/default_example":{"value":{"id":"6945258969368fe55125c4b9","description":"This is a sample template about how useful trees are","name":"Trees for Kids - Template","scenes":[{"id":"a517722a-582b-4f8c-bb8f-c8e8014cf6cc","type":"headline_txt","dynamicValues":[{"type":"color_fill","position":201},{"type":"color_fill","position":0},{"type":"color_fill","position":100},{"type":"color_fill","position":102},{"type":"header","position":0}],"name":"Amazing Tree Discovery","availableStagePositions":[{"id":"default","position":100,"x":0,"y":0,"height":0,"width":0}]},{"id":"08865dcb-d8f3-4dfd-964d-76304fbbfa9d","type":"img_and_headline_txt","dynamicValues":[{"type":"image","position":0},{"type":"color_fill","position":201},{"type":"color_fill","position":0},{"type":"color_fill","position":100},{"type":"color_fill","position":102},{"type":"header","position":0}],"name":"Tree Parts Explorer","availableStagePositions":[{"id":"default","position":100,"x":0,"y":0,"height":0,"width":0}]},{"id":"00566c97-a41a-45fe-a66c-36a868621297","type":"cta_txt","dynamicValues":[{"type":"logo","position":0},{"type":"color_fill","position":208},{"type":"color_fill","position":100},{"type":"color_fill","position":102},{"type":"website","position":0},{"type":"cta","position":0}],"name":"Nature Explorer Call","availableStagePositions":[{"id":"default","position":100,"x":0,"y":0,"height":0,"width":0}]}]},"key":"default_example","summary":"Detailed template information with all scenes","id":"paths/~1auth~1templates~1{templateId}/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example":{"value":{"prompt":"Breaking the Agency Mold - Building Long-Term Partnerships with Data","promptType":"Prompt","language":"en","videoLength":2,"toneOfVoice":"Professional","videoTagId":"Marketing","storyTellingTechnique":"The Before-and-After Transformation","toAutoEnhance":true,"toAutoExport":true,"webhook":"https://your-app.com/hooks/shuffll-export","additionalParams":{"campaignId":"camp_123"},"aiVoiceSettings":{"voiceId":"alloy","voiceType":"open-ai","voiceSpeed":1},"customTemplate":{"id":"67682e831de738f85b0d0fc9","description":"Agency-focused video brand. Tone: confident, data-driven, B2B. Audience: marketing directors.","flexibilityOverride":"flexible","toUseTemplateFont":true,"assets":[{"url":"https://example.com/product-demo.mp4","type":"video","description":"60-second product walkthrough showing the analytics dashboard.","direction":"Use in a middle scene to demonstrate product value."},{"url":"https://example.com/team-photo.jpg","type":"image","description":"Company team photo, outdoor setting."}],"videoSourcesByOrder":["workspace_assets","stock_footage","generate_from_image"],"preConfigs":{"bgMusic":{"volume":0.35,"path":"/music/upbeat-corporate.mp3"},"toCleanAudio":false,"subtitles":{"strategy":"WORD_HIGHLIGHT","textSize":18,"percentOffset":40,"fontName":"Arimo","isBold":true,"primaryColour":"#FFFFFF","outlineColour":"#000000","styles":{"normal":{"color":"#FFFFFF"},"highlight":{"color":"#FFD700"}}}},"scenes":[{"id":"a517722a-582b-4f8c-bb8f-c8e8014cf6cc","staticScript":"Data-driven agencies don't just win clients — they keep them for years.","dynamicValues":[{"position":0,"type":"header","value":"Breaking the Agency Mold"},{"position":0,"type":"logo","value":"https://example.com/logo.png"}],"wordBoost":["Shuffll","ROI"],"customSpelling":[{"from":["Shuffel","Shufflle"],"to":"Shuffll"}]},{"id":"08865dcb-d8f3-4dfd-964d-76304fbbfa9d","moreDetailsAboutScene":"Focus on the before/after contrast — struggling agency vs. data-driven success.","toGenerateMissingImages":true,"videosToAdd":[{"url":"https://content.shuffll.com/workspace/agency-intro.mp4","isMaster":true,"stagePositionNumber":100,"isMuted":false,"toAutoTrim":true}]}]}},"key":"basic_example","summary":"Full-featured project creation with template, assets, and webhook","id":"paths/~1auth~1project~1create/post/requestBody/content/application~1json/examples/basic_example"},"paths/~1auth~1project~1create/post/responses/200/content/application~1json/examples/default_example":{"value":{"projectId":"6947b539cc95ea68854bb523"},"key":"default_example","summary":"Project created successfully","id":"paths/~1auth~1project~1create/post/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/done":{"value":{"status":"DONE"},"key":"done","summary":"Creation complete","id":"paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/done"},"paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/in_progress":{"value":{"status":"GENERATING_IMAGES"},"key":"in_progress","summary":"Creation in progress","id":"paths/~1auth~1project~1{projectId}~1create~1status/get/responses/200/content/application~1json/examples/in_progress"},"paths/~1auth~1project~1{projectId}/get/responses/200/content/application~1json/examples/default_example":{"value":{"id":"6947b539cc95ea68854bb523","name":"Breaking the Agency Mold","status":"DONE","createdAt":"2025-12-15T07:26:34.333Z","workspaceId":"693fb82afd8d1c43077ba0fe"},"key":"default_example","summary":"Full project details","id":"paths/~1auth~1project~1{projectId}/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/200/content/application~1json/examples/default_example":{"value":{"percentages":100,"isDone":true},"key":"default_example","summary":"Enhancement complete","id":"paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/202/content/application~1json/examples/default_example":{"value":{"percentages":50,"isDone":false},"key":"default_example","summary":"Enhancement in progress","id":"paths/~1auth~1project~1{projectId}~1edit~1status~1enhance/get/responses/202/content/application~1json/examples/default_example"},"paths/~1auth~1project~1{projectId}~1edit~1export/post/responses/200/content/application~1json/examples/default_example":{"value":{"projectId":"3be6453c-03eb-4357-ae5a-984a0e574a54","editId":"2f14374a-9c65-4ee5-94b7-fba66d893483"},"key":"default_example","summary":"Export job started","id":"paths/~1auth~1project~1{projectId}~1edit~1export/post/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/200/content/application~1json/examples/default_example":{"value":{"isDone":true,"urls":{"uploadPath":"https://content.shuffll.com/exports/project.mp4","dashPath":"https://content.shuffll.com/exports/project.mpd"}},"key":"default_example","summary":"Export complete — video URLs available","id":"paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/200/content/application~1json/examples/default_example"},"paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/202/content/application~1json/examples/default_example":{"value":{"isDone":false,"urls":{}},"key":"default_example","summary":"Export still in progress","id":"paths/~1auth~1project~1{projectId}~1edit~1status~1export/get/responses/202/content/application~1json/examples/default_example"}},"securitySchemeStore":{"ShuffllApiKey":{"id":"ShuffllApiKey","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Obtain from Account Settings > API Integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: sfl-{key}.{secret}:{token}"},"children":[]}]}]}],"in":"header","paramName":"x-api-key"}},"servers":[{"url":"/_mock/apis","isMockServer":true,"description":"Mock server"},{"url":"https://api.shuffll.com/api/v1"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/index.json?download"},{"url":"/_bundle/apis/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Shuffll API","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"}},"baseSlug":"/apis","routesMapping":{}}