{"info":{"title":"ReelMade API","version":"1.0.0","description":"Start a video ad from a business website, answer its questions, draft the script and make the film. Starting a video, reading it, answering its questions and drafting the script work without an account; making the film needs a signed-in ReelMade user (the session cookie from signing in at https://reelmade.app). Agents acting for an owner should use the MCP server instead, which signs in with OAuth: https://reelmade.app/auth.md"},"servers":[{"url":"https://reelmade.app/api"}],"openapi":"3.1.1","paths":{"/videos":{"post":{"operationId":"videos.create","summary":"Start a video from a website: the engine reads it and writes the questions","tags":["Videos"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","minLength":2,"maxLength":500}},"required":["link"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"claimToken":{"anyOf":[{"type":"string"},{"type":"null"}]},"reused":{"type":"boolean"}},"required":["id","claimToken","reused"]}}}}}},"get":{"operationId":"videos.list","summary":"A workspace's videos, latest version of each","tags":["Videos"],"parameters":[{"name":"organizationId","in":"query","required":true,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":48,"default":24},"allowEmptyValue":true,"allowReserved":true},{"name":"status","in":"query","required":false,"schema":{"enum":["all","working","done","failed"],"type":"string","default":"all"},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"rootId":{"type":"string"},"link":{"type":"string"},"host":{"type":"string"},"name":{"type":"string"},"phase":{"enum":["research","questions","film","done","failed"],"type":"string"},"stage":{"enum":["queued","reading","understanding","planning","ready","waiting","writing","voicing","designing","checking","rendering","mixing","done","failed"],"type":"string"},"label":{"type":"string"},"stageAt":{"type":"string"},"createdAt":{"type":"string"},"hasAnswers":{"type":"boolean"},"posterUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"versionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"express":{"type":"boolean"}},"required":["id","rootId","link","host","name","phase","stage","label","stageAt","createdAt","hasAnswers","posterUrl","version","versionCount","express"]}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["items","nextCursor"]}}}}}}},"/videos/{id}":{"get":{"operationId":"videos.get","summary":"A video's stage, questions, script and files","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"claimToken","in":"query","schema":{"type":"string","minLength":20,"maxLength":100},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"link":{"type":"string"},"host":{"type":"string"},"name":{"type":"string"},"phase":{"enum":["research","questions","film","done","failed"],"type":"string"},"stage":{"enum":["queued","reading","understanding","planning","ready","waiting","writing","voicing","designing","checking","rendering","mixing","done","failed"],"type":"string"},"label":{"type":"string"},"stageAt":{"type":"string"},"createdAt":{"type":"string"},"retries":{"anyOf":[{"enum":["film","research"],"type":"string"},{"type":"null"}]},"failReason":{"anyOf":[{"enum":["site_unreachable","site_blocked","engine","timeout"],"type":"string"},{"type":"null"}]},"business":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"oneLiner":{"type":"string"},"language":{"type":"string","maxLength":10},"locale":{"type":"string","maxLength":20},"type":{"type":"string","maxLength":40},"kind":{"type":"string","maxLength":80},"offer":{"type":"string","maxLength":400},"brand":{"type":"object","properties":{"bg":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"ink":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"accent":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"accent2":{"type":"string","pattern":"^#[0-9a-f]{6}$"},"headingFont":{"type":"string","maxLength":60},"bodyFont":{"type":"string","maxLength":60},"mode":{"enum":["light","dark"],"type":"string"}},"required":["bg","ink","accent","accent2","headingFont","bodyFont","mode"]},"highlights":{"type":"array","maxItems":8,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":40},"title":{"type":"string","maxLength":80},"why":{"type":"string","maxLength":300}},"required":["id","title","why"]}},"audiences":{"type":"array","maxItems":6,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":40},"label":{"type":"string","maxLength":60},"callout":{"type":"string","maxLength":160},"problem":{"type":"string","maxLength":240}},"required":["id","label","callout","problem"]}},"actions":{"type":"array","maxItems":6,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":40},"label":{"type":"string","maxLength":60},"instruction":{"type":"string","maxLength":200}},"required":["id","label","instruction"]}},"scopes":{"type":"array","maxItems":8,"items":{"type":"object","properties":{"id":{"type":"string","maxLength":40},"label":{"type":"string","maxLength":60},"description":{"type":"string","maxLength":240}},"required":["id","label","description"]}}},"required":["name","oneLiner"]},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"about":{"type":"object","properties":{"ask":{"type":"string"},"why":{"type":"string"},"options":{"type":"array","minItems":2,"items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string","description":"<= 9 words, in the owner's words; for an opening line, the line itself"},"detail":{"type":"string","description":"<= 16 words: what it means for the video, or where we found it"},"source":{"enum":["found","suggested"],"type":"string","description":"found = on their site; suggested = our idea"},"ref":{"type":"string","description":"the map id it comes from (offering, proof, audience, side, action, urgency), or empty"},"photoId":{"type":"string"},"kind":{"enum":["whole","offering","side","offer"],"type":"string"}},"required":["id","label","detail","source","ref","photoId","kind"]},"description":"the whole business, then the 2-4 best single subjects (an offering, a live offer, one side)"},"pick":{"type":"string","description":"an option id"},"pickWhy":{"type":"string","description":"one sentence for us, not the owner"}},"required":["ask","why","options","pick","pickWhy"]},"focused":{"type":"object","properties":{"subject":{"type":"string","description":"the 'about' option id these questions are written for"},"questions":{"type":"array","minItems":3,"maxItems":6,"items":{"type":"object","properties":{"id":{"type":"string"},"ask":{"type":"string","description":"<= 10 words, plain, no marketing terms"},"why":{"type":"string","description":"<= 16 words, shown under the question: what the answer changes in their video"},"shapes":{"enum":["opening","message","proof","urgency","ending","story","feeling","sides","details"],"type":"string"},"multi":{"type":"boolean","description":"true when they may pick several"},"options":{"type":"array","minItems":2,"maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string","description":"<= 9 words, in the owner's words; for an opening line, the line itself"},"detail":{"type":"string","description":"<= 16 words: what it means for the video, or where we found it"},"source":{"enum":["found","suggested"],"type":"string","description":"found = on their site; suggested = our idea"},"ref":{"type":"string","description":"the map id it comes from (offering, proof, audience, side, action, urgency), or empty"},"photoId":{"type":"string"}},"required":["id","label","detail","source","ref","photoId"]},"description":"2-5, best first"},"pick":{"type":"array","items":{"type":"string"},"description":"our recommendation: option ids"},"typeYourOwn":{"type":"string","description":"placeholder for a typed answer when theirs may differ, e.g. 'Your code and end date', or empty"}},"required":["id","ask","why","shapes","multi","options","pick","typeYourOwn"]},"description":"3-6"}},"required":["subject","questions"]},"whole":{"type":"object","properties":{"questions":{"type":"array","minItems":3,"maxItems":6,"items":{"type":"object","properties":{"id":{"type":"string"},"ask":{"type":"string","description":"<= 10 words, plain, no marketing terms"},"why":{"type":"string","description":"<= 16 words, shown under the question: what the answer changes in their video"},"shapes":{"enum":["opening","message","proof","urgency","ending","story","feeling","sides","details"],"type":"string"},"multi":{"type":"boolean","description":"true when they may pick several"},"options":{"type":"array","minItems":2,"maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string","description":"<= 9 words, in the owner's words; for an opening line, the line itself"},"detail":{"type":"string","description":"<= 16 words: what it means for the video, or where we found it"},"source":{"enum":["found","suggested"],"type":"string","description":"found = on their site; suggested = our idea"},"ref":{"type":"string","description":"the map id it comes from (offering, proof, audience, side, action, urgency), or empty"},"photoId":{"type":"string"}},"required":["id","label","detail","source","ref","photoId"]},"description":"2-5, best first"},"pick":{"type":"array","items":{"type":"string"},"description":"our recommendation: option ids"},"typeYourOwn":{"type":"string","description":"placeholder for a typed answer when theirs may differ, e.g. 'Your code and end date', or empty"}},"required":["id","ask","why","shapes","multi","options","pick","typeYourOwn"]},"description":"3-6"}},"required":["questions"]},"skipped":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"because":{"type":"string"}},"required":["topic","because"]},"description":"questions we chose not to ask, and why (the map already knows, or it would not change the video)"},"more":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"ask":{"type":"string","description":"<= 10 words, plain, no marketing terms"},"why":{"type":"string","description":"<= 16 words, shown under the question: what the answer changes in their video"},"shapes":{"enum":["opening","message","proof","urgency","ending","story","feeling","sides","details"],"type":"string"},"multi":{"type":"boolean","description":"true when they may pick several"},"options":{"type":"array","minItems":2,"maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string","description":"<= 9 words, in the owner's words; for an opening line, the line itself"},"detail":{"type":"string","description":"<= 16 words: what it means for the video, or where we found it"},"source":{"enum":["found","suggested"],"type":"string","description":"found = on their site; suggested = our idea"},"ref":{"type":"string","description":"the map id it comes from (offering, proof, audience, side, action, urgency), or empty"},"photoId":{"type":"string"}},"required":["id","label","detail","source","ref","photoId"]},"description":"2-5, best first"},"pick":{"type":"array","items":{"type":"string"},"description":"our recommendation: option ids"},"typeYourOwn":{"type":"string","description":"placeholder for a typed answer when theirs may differ, e.g. 'Your code and end date', or empty"}},"required":["id","ask","why","shapes","multi","options","pick","typeYourOwn"]}},"default":{}},"pending":{"type":"array","items":{"type":"string"},"default":[]},"failed":{"type":"array","items":{"type":"string"},"default":[]}},"required":["about","focused","whole","skipped"]},{"type":"null"}]},"answers":{"anyOf":[{"type":"object","properties":{"about":{"type":"string","minLength":1,"maxLength":100},"picks":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"array","maxItems":6,"items":{"type":"string","maxLength":40}}},"typed":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":240}},"placements":{"type":"array","maxItems":4,"items":{"enum":["ads","posts","shorts","web"],"type":"string"}},"length":{"enum":["15","30","45","60","auto"],"type":"string"},"voice":{"type":"string","minLength":1,"maxLength":100},"voiceName":{"type":"string","maxLength":60},"language":{"type":"string"},"screenLanguage":{"type":"string"},"text":{"enum":["words","captions","subtitles","none","auto"],"type":"string"},"skipPhotos":{"type":"string","maxLength":300,"pattern":"^[a-z0-9,]*$"},"notes":{"type":"string","maxLength":1000},"scenes":{},"express":{"type":"boolean"}},"required":["about","picks","typed","placements","length","voice","voiceName","language","screenLanguage","text","skipPhotos","notes","express"]},{"type":"null"}]},"script":{"anyOf":[{"type":"object","properties":{"title":{"type":"string"},"concept":{"type":"string"},"voice":{"type":"string"},"lines":{"type":"array","items":{"type":"string"}},"post":{"type":"object","properties":{"text":{"type":"string"},"headline":{"type":"string"}},"required":["text","headline"]}},"required":["title","concept","voice","lines"]},{"type":"null"}]},"draft":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"pending":{"type":"boolean"},"failed":{"type":"boolean"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"say":{"type":"string"},"screen":{"type":"string"},"asset":{"type":"string"}},"required":["id","say","screen"]}}},"required":["key","pending","failed","lines"]},{"type":"null"}]},"assets":{"anyOf":[{"type":"object","properties":{"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"screenshotUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"photos":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"large":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"label":{"type":"string"},"own":{"type":"boolean"},"subject":{"anyOf":[{"enum":["own-product","own-place","own-people","own-work","own-customers","product-screen","decorative","stock","third-party","graphic","low-quality"],"type":"string"},{"const":""}]}},"required":["id","url","large","width","height","label","own","subject"]}},"photoCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["logoUrl","screenshotUrl","photos","photoCount","skipped"]},{"type":"null"}]},"frames":{"type":"array","items":{"type":"string"}},"videoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"posterUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"owned":{"type":"boolean"},"isMine":{"type":"boolean"},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rootId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"remakeNotes":{"anyOf":[{"type":"string"},{"type":"null"}]},"express":{"type":"boolean"},"creditSpent":{"type":"boolean"},"creditReturned":{"type":"boolean"},"canRemake":{"type":"boolean"}},"required":["id","link","host","name","phase","stage","label","stageAt","createdAt","retries","failReason","business","plan","answers","script","draft","assets","frames","videoUrl","downloadUrl","posterUrl","owned","isMine","organizationId","version","rootId","parentId","remakeNotes","express","creditSpent","creditReturned","canRemake"]}}}}}}},"/videos/{id}/watch":{"get":{"operationId":"videos.watch","summary":"Stream a video's progress (SSE) until it needs the visitor or is finished","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}},{"name":"claimToken","in":"query","schema":{"type":"string","minLength":20,"maxLength":100},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/videos/{id}/answers":{"post":{"operationId":"videos.saveAnswers","summary":"Save the questionnaire answers so far","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"about":{"type":"string","minLength":1,"maxLength":100},"picks":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"array","maxItems":6,"items":{"type":"string","maxLength":40}}},"typed":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":240}},"placements":{"type":"array","maxItems":4,"items":{"enum":["ads","posts","shorts","web"],"type":"string"}},"length":{"enum":["15","30","45","60","auto"],"type":"string"},"voice":{"type":"string","minLength":1,"maxLength":100},"voiceName":{"type":"string","maxLength":60},"language":{"type":"string"},"screenLanguage":{"type":"string"},"text":{"enum":["words","captions","subtitles","none","auto"],"type":"string"},"skipPhotos":{"type":"string","maxLength":300,"pattern":"^[a-z0-9,]*$"},"notes":{"type":"string","maxLength":1000},"scenes":{"type":"array","maxItems":14,"items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":20},"say":{"type":"string","minLength":1,"maxLength":220},"asset":{"type":"string","maxLength":40,"pattern":"^[a-z0-9-]+$"}},"required":["id","say","asset"]},{"type":"null"}]}},"express":{"type":"boolean"}},"required":["about","picks","typed","placements","length","voice","voiceName","language","screenLanguage","text","skipPhotos","notes","scenes","express"]},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["answers"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"savedAt":{"type":"string"}},"required":["id","savedAt"]}}}}}}},"/videos/{id}/draft-script":{"post":{"operationId":"videos.draftScript","summary":"Draft the script for the current answers, before paying","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"about":{"type":"string","minLength":1,"maxLength":100},"picks":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"array","maxItems":6,"items":{"type":"string","maxLength":40}}},"typed":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":240}},"placements":{"type":"array","maxItems":4,"items":{"enum":["ads","posts","shorts","web"],"type":"string"}},"length":{"enum":["15","30","45","60","auto"],"type":"string"},"voice":{"type":"string","minLength":1,"maxLength":100},"voiceName":{"type":"string","maxLength":60},"language":{"type":"string"},"screenLanguage":{"type":"string"},"text":{"enum":["words","captions","subtitles","none","auto"],"type":"string"},"skipPhotos":{"type":"string","maxLength":300,"pattern":"^[a-z0-9,]*$"},"notes":{"type":"string","maxLength":1000},"scenes":{"type":"array","maxItems":14,"items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":20},"say":{"type":"string","minLength":1,"maxLength":220},"asset":{"type":"string","maxLength":40,"pattern":"^[a-z0-9-]+$"}},"required":["id","say","asset"]},{"type":"null"}]}},"express":{"type":"boolean"}},"required":["about","picks","typed","placements","length","voice","voiceName","language","screenLanguage","text","skipPhotos","notes","scenes","express"]},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["answers"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/videos/{id}/plan-subject":{"post":{"operationId":"videos.planSubject","summary":"Write the questions for another subject","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":40},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["subject"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/videos/{id}/photos/upload":{"post":{"operationId":"videos.photoUpload","summary":"Get a URL to upload one of your own photos","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contentType":{"const":"image/jpeg"},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["contentType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uploadUrl":{"type":"string"},"upload":{"type":"string"}},"required":["uploadUrl","upload"]}}}}}}},"/videos/{id}/photos":{"post":{"operationId":"videos.addPhoto","summary":"Add one of your own photos to the video","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"upload":{"type":"string","pattern":"^[A-Za-z0-9_-]{16}$"},"label":{"type":"string","maxLength":80},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["upload"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/videos/{id}/preview-voice":{"post":{"operationId":"videos.previewVoice","summary":"Hear a line in a voice","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"voice":{"type":"string","minLength":1,"maxLength":40},"language":{"type":"string","default":"en"},"text":{"type":"string","minLength":2,"maxLength":160},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["voice","text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}}}}}},"/videos/voices/suggested":{"get":{"operationId":"videos.suggestVoices","summary":"Suggested voices for a language","tags":["Videos"],"parameters":[{"name":"language","in":"query","required":true,"schema":{"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"locale","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2,3}-[A-Za-z0-9]{2,4}$"},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tagline":{"type":"string"},"gender":{"enum":["f","m",""],"type":"string"},"age":{"type":"string"},"accent":{"type":"string"},"locale":{"type":"string"},"useCase":{"type":"string"},"sample":{"type":"string"},"language":{"type":"string"},"ours":{"type":"boolean"}},"required":["id","name","tagline","gender","age","accent","locale","useCase","sample","language","ours"]}}},"required":["voices"]}}}}}}},"/videos/voices/library":{"get":{"operationId":"videos.voiceLibrary","summary":"Browse the voice library","tags":["Videos"],"parameters":[{"name":"language","in":"query","required":true,"schema":{"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"locale","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2,3}-[A-Za-z0-9]{2,4}$"},"allowEmptyValue":true,"allowReserved":true},{"name":"gender","in":"query","required":false,"schema":{"enum":["f","m"],"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"age","in":"query","required":false,"schema":{"enum":["young","middle_aged","old"],"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"useCase","in":"query","required":false,"schema":{"enum":["advertisement","narrative_story","conversational","social_media","informative_educational","characters_animation","entertainment_tv"],"type":"string"},"allowEmptyValue":true,"allowReserved":true},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":60},"allowEmptyValue":true,"allowReserved":true},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100,"default":0},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"voices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tagline":{"type":"string"},"gender":{"enum":["f","m",""],"type":"string"},"age":{"type":"string"},"accent":{"type":"string"},"locale":{"type":"string"},"useCase":{"type":"string"},"sample":{"type":"string"},"language":{"type":"string"},"ours":{"type":"boolean"}},"required":["id","name","tagline","gender","age","accent","locale","useCase","sample","language","ours"]}},"nextCursor":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"type":"number"},"locales":{"type":"array","items":{"type":"string"}}},"required":["voices","nextCursor","total","locales"]}}}}}}},"/videos/{id}/claim":{"post":{"operationId":"videos.claim","summary":"Save an anonymous video to your workspace","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["claimToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"claimed":{"type":"boolean"}},"required":["id","organizationId","claimed"]}}}}}}},"/videos/{id}/generate":{"post":{"operationId":"videos.generate","summary":"Make the film from the questionnaire answers (videos used: 1, 2 for express)","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"type":"object","properties":{"about":{"type":"string","minLength":1,"maxLength":100},"picks":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"array","maxItems":6,"items":{"type":"string","maxLength":40}}},"typed":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":240}},"placements":{"type":"array","maxItems":4,"items":{"enum":["ads","posts","shorts","web"],"type":"string"}},"length":{"enum":["15","30","45","60","auto"],"type":"string"},"voice":{"type":"string","minLength":1,"maxLength":100},"voiceName":{"type":"string","maxLength":60},"language":{"type":"string"},"screenLanguage":{"type":"string"},"text":{"enum":["words","captions","subtitles","none","auto"],"type":"string"},"skipPhotos":{"type":"string","maxLength":300,"pattern":"^[a-z0-9,]*$"},"notes":{"type":"string","maxLength":1000},"scenes":{"type":"array","maxItems":14,"items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":20},"say":{"type":"string","minLength":1,"maxLength":220},"asset":{"type":"string","maxLength":40,"pattern":"^[a-z0-9-]+$"}},"required":["id","say","asset"]},{"type":"null"}]}},"express":{"type":"boolean"}},"required":["about","picks","typed","placements","length","voice","voiceName","language","screenLanguage","text","skipPhotos","notes","scenes","express"]},"express":{"type":"boolean"},"claimToken":{"type":"string","minLength":20,"maxLength":100}},"required":["answers"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/videos/{id}/retry":{"post":{"operationId":"videos.retry","summary":"Try a failed video again: the reading is free, the film uses its videos again","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"claimToken":{"type":"string","minLength":20,"maxLength":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"kind":{"enum":["film","research"],"type":"string"}},"required":["id","kind"]}}}}}}},"/videos/{id}/remake":{"post":{"operationId":"videos.remake","summary":"Make a new version of a finished video with changes (videos used: 1, 2 for express)","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"type":"string","minLength":5,"maxLength":1000},"voice":{"type":"string","minLength":1,"maxLength":40},"voiceName":{"type":"string","maxLength":60},"language":{"type":"string"},"length":{"enum":["15","30","45","60"],"type":"string"},"express":{"type":"boolean"}},"required":["notes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/videos/{id}/versions":{"get":{"operationId":"videos.versions","summary":"Every version of a video","tags":["Videos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stage":{"enum":["queued","reading","understanding","planning","ready","waiting","writing","voicing","designing","checking","rendering","mixing","done","failed"],"type":"string"},"phase":{"enum":["research","questions","film","done","failed"],"type":"string"},"createdAt":{"type":"string"},"posterUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"remakeNotes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","version","stage","phase","createdAt","posterUrl","remakeNotes"]}}},"required":["items"]}}}}}}},"/credits/balance":{"get":{"operationId":"credits.balance","summary":"Videos the workspace can make, and its plan","tags":["Credits"],"parameters":[{"name":"organizationId","in":"query","required":true,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}}},"externalDocs":{"url":"https://reelmade.app/agents"}}