Tutorializer Video Tutorials

Create speecha voiceover line

CreateUse onethis Tutorializerwhen voiceoversomeone segmentwants fornew narration or voiceover in a project. WithoutReturns athe urlnew itline's synthesizesid, narrationlanguage, voice and audio URL. Without url the audio is synthesized from the text with the project's speechvoice provider, which consumesspending the organization's synthesis credits and is billable.credits; Passwith url instead toit registerrecords audio you already produced. State-changing and non-idempotent: repeating the callhave. createsNot anotherfor segmentfixing andan synthesizesexisting again.line.

 ⟨7 unchanged words⟩ "description":"Language code of the narration, for examplee.g. en or pt-BR","maxLength":32,"minLength ⟨2 unchanged words⟩ string"},"projectId":{"description":"Project id that will own the voiceover segmentline belongs to","maxLength":200,"minLength":1,"type":"string"},"text":{"description":"Narration textWords to speak, up to 5000 characters","maxLength":5000,"minLength":1,"type ⟨64 unchanged words⟩ 

 ⟨100 unchanged words⟩ ,"type":"string"},"synthesized":{"description":"True when audio was synthesized and synthesis credits were spent; false when a url was recorded","type":"boolean"}},"required":["status ⟨4 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Create speecha voiceover line"}

Create a tutorial

CreateUse athis Tutorializerwhen tutorialsomeone definitionwants insideto add a project.new State-changingtutorial andto non-idempotent:a repeatingproject. Returns the callnew createstutorial's anotherid, tutorialname, soproject listand tutorialsdefault andvoice. confirmEach thecall intendedcreates nameanother first.tutorial; Thisit records the tutorial;tutorial itwithout doesrecording notor recordrendering ora rendervideo. Not for adding a rendered video.

 ⟨25 unchanged words⟩ "},"name":{"description":"Tutorial name, up to 200 characters","maxLength":200,"minLength":1,"type":"string"},"projectId":{"description":"Project id that will own the tutorial belongs to","maxLength":200,"minLength":1,"type ⟨6 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Create a tutorial"}

CreateAdd a rendered tutorial video

Register one already-uploadedUse renderedthis tutorialwhen videosomeone withhas Tutorializer,an recordingalready itsuploaded locale,tutorial device,video dimensionsfile and media URLs. State-changingwants andit non-idempotent:listed repeatingunder thea calltutorial. registersReturns athe secondnew output.video Thisrecord doeswith notits recordlanguage, render ordevice, uploaddimensions aand file;URLs. hostHost the file first and pass its public https URL.URL; each call adds another record. Not for recording, rendering or uploading a video.

 ⟨8 unchanged words⟩ #/properties/url","description":"Public https URL of the chapters track"},"device":{"description":"Device profile,the forvideo examplewas rendered for: computer, tablet or smartphone","maxLength":100,"minLength":1 ⟨2 unchanged words⟩ ,"duration":{"description":"Duration in seconds, up to 86400","maximum":86400,"minimum":0,"type ⟨13 unchanged words⟩ format":{"description":"Container or codec, for examplee.g. mp4 or webm","maxLength":100,"minLength":1,"type":"string"},"height":{"description":"Height in pixels, 1 to 100000","exclusiveMinimum":0,"maximum":100000,"type":"integer"},"locale":{"description":"LocaleLanguage code of this rendervideo, for examplee.g.

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"CreateAdd a rendered tutorial video"}

Delete speecha voiceover line

PermanentlyUse deletethis when someone wants one Tutorializervoiceover speechline recordpermanently plusdeleted with its S3audio. Returns the deleted line id; the audio and alignmenttiming files.files Idempotentare erased, butso deletedrestoring audioit cannotmeans besynthesizing recoveredagain, withoutwhich synthesizingspends credits. Deleting it again andchanges spendingnothing. credits.Not for changing its words.

 ⟨5 unchanged words⟩ ,"properties":{"speechId":{"description":"SpeechVoiceover idline to delete","maxLength":200,"minLength": ⟨7 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Delete speecha voiceover line"}

Delete a tutorial

PermanentlyUse deletethis onewhen Tutorializersomeone wants a tutorial definition.permanently Idempotent,deleted. butReturns the definition mustdeleted betutorial authoredid; againits tovideos restoreand it.voiceover Renderedlines videosstay and voiceovereach segmentsneeds areits notown deleteddelete. withDeleting it;it removeagain thosechanges separately.nothing. Not for removing one language or device version.

 ⟨5 unchanged words⟩ properties":{"tutorialId":{"description":"Tutorial id to delete","maxLength":200,"minLength":1 ⟨6 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Delete a tutorial"}

Delete a tutorial video

PermanentlyUse deletethis when someone wants one Tutorializerrendered rendered-videotutorial video permanently deleted. Returns the deleted video id; the record and its primaryvideo S3file object.in Idempotent,Tutorializer butstorage theare rendererased, mustso berestoring uploadedit means uploading or generatedrendering againagain. toNot restorefor it.deleting the whole tutorial.

 ⟨5 unchanged words⟩ ,"properties":{"videoId":{"description":"Rendered video idVideo to delete","maxLength":200,"minLength": ⟨7 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Delete a tutorial video"}

Get project settings

FetchUse athis singlewhen Tutorializersomeone projectasks byabout immutableone idproject's orlanguages, stabledefault publicvoice, vanitynarration id.speed Returnsor thepronunciation projectrules. metadata,Returns its localename, domain, default and configured locales, voice settings, and anyup to 50 pronunciation rules, formattedlooked asup Markdown.by project id or vanity id. Not for finding languages or devices that lack videos.

 ⟨6 unchanged words⟩ "projectId":{"description":"Project id or its stable public vanity id","maxLength":200," ⟨8 unchanged words⟩ 

 ⟨193 unchanged words⟩ :"object"},{"type":"null"}],"description":"Project settings; null when not found. Organization ids and pronunciation-dictionary ids are never returned."},"status":{"enum":["found", ⟨8 unchanged words⟩ 

 ⟨5 unchanged words⟩ false,"readOnlyHint":true,"title":"Get project settings"}

AuditCheck projectmissing localizationlanguages and devices

AuditUse onethis Tutorializerwhen someone asks which languages or devices a project acrossstill configuredlacks locales,tutorial rendered-videovideos locales/devicesor voiceovers for, or how complete its translations are. Returns video and speechvoiceover languages.counts Readsper atlanguage mostand 100video rowscounts per contentdevice, typeplus andthe marksmissing truncatedones, totalsfrom asthe lowerlatest bounds.100 of each. Not for one tutorial's videos.

 ⟨5 unchanged words⟩ ,"properties":{"expectedDevices":{"description":"ExpectedDevices outputeach devicelanguage names;should defaultshave videos for, 1 to 10 names such as computer, tablet, andor smartphonesmartphone; defaults to those three","items":{"maxLength":40,"minLength" ⟨8 unchanged words⟩ :"array"},"projectId":{"description":"Tutorializer projectProject id or its stable public vanity id","maxLength":200, ⟨8 unchanged words⟩ 

 ⟨223 unchanged words⟩ :"object"},{"type":"null"}],"description":"Coverage from at most the 100 most recently edited tutorials, videos and voiceover lines; coverageDerivedFromTruncatedData is true when more exist. Null when the project is not found."}},"required":["status","summary"] ⟨2 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"AuditCheck projectmissing localizationlanguages and devices"}

GetRead speecha voiceover line

FetchUse athis singlewhen Tutorializersomeone speechneeds (voiceoverthe segment)full bywording id.or Returnstranslation theof speechone metadatavoiceover plusline, or its fullaudio link. Returns its source text, translation, language, voice, duration, project and translationaudio formattedURL. asNot Markdown.for changing the words.

 ⟨5 unchanged words⟩ ,"properties":{"speechId":{"description":"SpeechVoiceover idline (uuid)id","maxLength":200,"minLength":1,"type ⟨5 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetRead speecha voiceover line"}

Get a tutorial and its videos

FetchUse onethis Tutorializerwhen someone asks about one tutorial definitionand the videos rendered from it. Returns the tutorial's name, project and adefault boundedvoice previewplus up to 8 of its renderedmost locale/devicerecently outputs.edited Avideos tutorialwith doeslanguage, notdevice, itselfformat, havesize aand localemedia orlinks. status;Not thosefor varyevery pervideo video.in a project.

 ⟨6 unchanged words⟩ ":{"tutorialId":{"description":"Tutorial id (uuid)","maxLength":200,"minLength":1,"type ⟨5 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Get a tutorial and its videos"}

Get video details

FetchUse athis singlewhen renderedsomeone Tutorializerasks about one tutorial video, bysuch id.as its link, subtitles, chapters or thumbnail. Returns its tutorial, localelanguage, device, dimensions, primaryand mediaits URLvideo, chapters, subtitles, and thumbnail metadata.URLs. Not for changing those details.

 ⟨6 unchanged words⟩ ":{"videoId":{"description":"Video id (uuid)","maxLength":200,"minLength":1,"type ⟨5 unchanged words⟩ 

 ⟨5 unchanged words⟩ false,"readOnlyHint":true,"title":"Get video details"}

List your tutorial projects

ListUse athis boundedwhen pagesomeone ofasks which Tutorializer projects thethey authenticatedhave, useror hasa accessproject's to.id Returnsis aneeded. MarkdownReturns tableeach ofproject's id, name, domainvanity id, domain and lastcreated editand time.edited times, sorted by name, 25 per page by default. Not for a project's languages or voice settings.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe cursornextCursor fromof athe previous callpage; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Projects per page, from 1 to 100; defaults to 25","exclusiveMinimum":0,"maximum":100,"type": ⟨3 unchanged words⟩ 

 ⟨14 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"},"offset":{"maximum":1000000,"minimum" ⟨91 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List your tutorial projects"}

List speechesvoiceover lines

List aUse boundedthis pagewhen ofsomeone Tutorializerasks speecheswhich (voiceover segments).or Optionallynarration filterlines bya projectIdproject andhas, language.optionally Returnsin aone safelanguage. previewReturns ofeach line's id, a short text preview, language, project, and URL.audio URL, most recently edited first, 25 per page by default. Not for the full text of one line.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe cursornextCursor fromof athe previous callpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"language":{"description":"FilterOnly speecheslines byin this language code, e.g. en, es, or de","maxLength":32,"type":"string"},"limit":{"description":"Voiceover lines per page, from 1 to 100; defaults to 25","exclusiveMinimum":0,"maximum":100,"type":"integer"},"projectId":{"description":"FilterOnly speechesvoiceover by

 ⟨22 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"},"offset":{"maximum":1000000,"minimum" ⟨15 unchanged words⟩ 0,"type":"integer"},"speeches":{"description":"Voiceover lines with a text preview of up to 120 characters, not the full text","items":{"additionalProperties":false,"properties":{ ⟨91 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List speechesvoiceover lines"}

ListUse Tutorializerthis tutorialwhen definitions.someone Optionallyasks filterwhich bytutorials projectId.a Returnsproject has, or when another tool needs a Markdowntutorial tableid. ofReturns each tutorial's id, name, project, default voice, and lasttimes, editmost time;recently edited first, 25 per page by default. Not for the rendered localesvideos andof deviceseach livelanguage onor videos.device.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe cursornextCursor fromof athe previous callpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Tutorials per page, from 1 to 100; defaults to 25","exclusiveMinimum":0,"maximum":100,"type":"integer"},"projectId":{"description":"FilterOnly tutorials byin this project; every project idwhen absent","maxLength":200,"type":"string"} ⟨2 unchanged words⟩ 

 ⟨14 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"},"offset":{"maximum":1000000,"minimum" ⟨100 unchanged words⟩ 

List tutorial videos

ListUse renderedthis Tutorializerwhen videos.someone Optionallyasks filterwhich bytutorial projectIdvideos exist, tutorialIdoptionally for one project, localetutorial, andlanguage or device. Returns a Markdown tableeach ofvideo's outputid, dimensionstutorial, localelanguage, device, format, dimensions, file size and URL.URL, most recently edited first, 25 per page by default. Not for checking missing languages.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"OpaqueThe cursornextCursor fromof athe previous callpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"device":{"description":"FilterOnly byvideos for this device: computer, e.g.tablet desktop,or smartphone","maxLength":100,"type":"string"},"limit":{"description":"Videos per page, from 1 to 100; defaults to 25","exclusiveMinimum":0,"maximum":100,"type":"integer"},"locale":{"description":"FilterOnly byvideos 

 ⟨30 unchanged words⟩ :"string"},{"type":"null"}],"description":"Cursor for the next page; null on the last page"},"offset":{"maximum":1000000,"minimum" ⟨171 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List tutorial videos"}

Remove a pronunciation rulefix

RemoveUse onethis projectwhen someone wants to drop a pronunciation rule andso synchronizea itsword ElevenLabsis dictionary.spoken Destructivethe butdefault idempotent:way aagain. missingReturns whether it was removed and the remaining rule iscount; a no-op.missing Existingrule speechchanges nothing, and existing audio is notkept regeneratedas automatically.it is. Not for changing a rule's phonemes.

 ⟨5 unchanged words⟩ ,"properties":{"projectId":{"description":"TutorializerProject projectthe idrule belongs to","maxLength":200,"minLength":1,"type ⟨24 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Remove a pronunciation rulefix"}

SetFix pronunciationhow rulea word is pronounced

AddUse this when narration mispronounces a word, name or replacebrand onein projecta pronunciationproject's voiceovers. Returns the rule and synchronizethe itsproject's ElevenLabsrule count after adding or replacing it (IPA or CMU phonemes, up to 500 rules) and syncing the pronunciation dictionary.dictionary Repeatingused anfor identicallater rulesynthesis. isNot afor no-op.re-voicing lines that already have audio.

 ⟨5 unchanged words⟩ properties":{"alphabet":{"description":"Phonetic alphabet;alphabet: ipa or cmu; defaults to ipa","enum":["ipa","cmu"],"type":"string"},"phonemes":{"description":"PhoneticHow pronunciationto say it, in the chosen phonetic alphabet, up to 500 characters","maxLength":500,"minLength":1,"type":"string"},"projectId":{"description":"TutorializerProject projectwhose idnarration to fix","maxLength":200,"minLength":1,"type":"string"},"word":{"description":"WordExact word or phrase to match, up to 120 characters","maxLength":120,"minLength":1,"type ⟨7 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"SetFix pronunciationhow rulea word is pronounced"}

Show Tutorializer project overview

RenderUse this when someone wants a boundedquick tenant-scopedvisual overview of one Tutorializer projectproject. snapshotReturns a card with tutorialthe project's name, videodomain and logo, how many tutorials, videos and voiceover counts.lines Useit thishas after(counted listingup projectsto or100 wheneach) theand userits provides8 anmost immutablerecently projectedited idtutorials. orNot stablefor publicmissing vanitylanguages id.or devices.

 ⟨3 unchanged words⟩ ,"properties":{"projectId":{"description":"Tutorializer projectProject id or its stable public vanity id to render","maxLength":200,"minLength":1,"type ⟨5 unchanged words⟩ 

{"destructiveHint":false,"openWorldHint":false,"readOnlyHint":true,"title":"Show project overview"}

UpdateChange project settings

ChangeUse this when someone wants to rename a Tutorializerproject project’sor name,change its domain, localeslanguages, default voice or narration speed. Reads the stored project first and rewritesReturns the wholeupdated record,settings; sofields unspecifiedleft fieldsout keep their current values. The locales list is a complete replacementvalues, and removing a locale stops it being expected by thenew localizationlocales audit.list Submittingreplaces the values itwhole alreadyset. hasNot isfor apronunciation no-op.fixes.

 ⟨5 unchanged words⟩ properties":{"defaultLocale":{"description":"New defaultmain locale,language forcode, examplee.g. en or pt-BR","maxLength":16,"minLength ⟨18 unchanged words⟩ domain":{"description":"New product domain, for examplee.g. example.com","maxLength":253,"minLength":1,"type":"string"},"locales":{"description":"Complete replacement list of localeslanguage codes the project publishes.publishes, Locales1 absentto from100; thisit replaces the current 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"UpdateChange project settings"}

UpdateChange speecha voiceover line

ChangeUse this when someone wants to change the textwords, translation, language or voice of one Tutorializer voiceover segment. Every one of those fieldsline. determinesReturns the audio,updated soline. aA real change re-synthesizes theits segmentaudio with the project's speechvoice provider, consumesspending synthesis credits and replacesreplacing the previous audio.old Submittingaudio; theidentical values it already haschange isnothing. aNot no-opfor thatproject-wide synthesizespronunciation nothing.fixes.

 ⟨6 unchanged words⟩ ":{"language":{"description":"New language code, e.g. en or pt-BR","maxLength":32,"minLength":2,"type":"string"},"speechId":{"description":"Voiceover segment idline to edit","maxLength":200,"minLength":1,"type":"string"},"text":{"description":"New narrationwords textto speak, up to 5000 characters","maxLength":5000,"minLength":1,"type ⟨17 unchanged words⟩ ,"voice":{"description":"New voice id for this line","maxLength":200,"minLength":1,"type ⟨5 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"resynthesized":{"description":"True when the change re-synthesized the audio and spent synthesis credits","type":"boolean"},"speech":{"anyOf" ⟨104 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"UpdateChange speecha voiceover line"}

UpdateRename a tutorial or change its voice

RenameUse athis Tutorializerwhen someone wants to rename a tutorial or change the default voice used forof its narration. Reads the stored tutorial first and rewritesReturns the wholeupdated record,tutorial; sofields unspecifiedleft fieldsout keep their currentvalues, values.and Submittingrepeating the same values itchanges alreadynothing. hasNot isfor aediting no-op.narration text.

 ⟨21 unchanged words⟩ ,"name":{"description":"New tutorial name, up to 200 characters","maxLength":200,"minLength":1,"type":"string"},"tutorialId":{"description":"Tutorial id to edit","maxLength":200,"minLength": ⟨7 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"UpdateRename a tutorial or change its voice"}

UpdateFix videoa video's details

Correct the metadataUse ofthis onewhen registeredsomeone Tutorializerwants renderedto video,correct sucha astutorial itsvideo's localelanguage, device, dimensions or media URLs., Readsfile thelink, storedsubtitles, recordchapters firstor andthumbnail. rewritesReturns the whole document,updated sovideo unspecifiedrecord; fields left out keep their current values.values Submittingand theidentical values itchange alreadynothing. hasNot isfor are-rendering no-op.the video itself.

 ⟨5 unchanged words⟩ properties":{"chaptersUrl":{"$ref":"#/properties/url","description":"New public https URL of the chapters track"},"device":{"description":"New device: computer, tablet or smartphone","maxLength":100,"minLength":1,"type":"string"},"duration":{"description":"New duration in seconds, up to 86400","maximum":86400,"minimum":0,"type":"number"},"fileSize":{"description":"New file size in bytes","maximum":1000000000000000,"minimum":0,"type":"number"},"format":{"description":"New container or codec, e.g. mp4 or webm","maxLength":100,"minLength":1,"type":"string"},"height":{"description":"New height in pixels, 1 to 100000","exclusiveMinimum":0,"maximum":100000,"type":"integer"},"locale":{"description":"New language code, e.g. en or pt-BR","maxLength":32,"minLength":2,"type":"string"},"subtitlesUrl":{"$ref":"#/properties/url","description":"New public https URL of a WebVTT subtitle track"},"thumbnailUrl":{"$ref":"#/properties/url","description":"New public https URL of the poster image"},"url":{"description":"New public  ⟨11 unchanged words⟩ :"string"},"videoId":{"description":"RenderedVideo videoto idcorrect","maxLength":200,"minLength":1,"type":"string"},"width":{"description":"New width in pixels, 1 to 100000",

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"UpdateFix videoa video's details"}