Multilocale Translations

Add keya withstring translationsand translate it

CreateUse this when someone asks to add a new string or key into atheir project’sapp's defaulttranslations. localeReturns andthe generatecreated translationskey forwith everyone othermachine translation per configured locale.locale, Omitmade valuefrom tothe usesource text in the default locale. A key asthat itsalready sourceexists value.returns Refusesalready-exists toand overwriteis left unchanged. Not for changing an existing key.translation.

 ⟨5 unchanged words⟩ ,"properties":{"context":{"description":"OptionalNote contextfor thatthe helpstranslator translatorsthat disambiguatedisambiguates the phrase.string, up to 600 characters","maxLength":600,"type":"string"},"key":{"description":"New exactkey, phrase1 keyto 256 characters","maxLength":256,"minLength":1,"type":"string"},"model":{"description":"Translation model to use.id; Defaultsdefaults to gpt-6-luna.gpt-6-luna","maxLength":64,"type":"string"},"project":{"description":"Project 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Add keya withstring translationsand translate it"}

AddCreate a localization project

CreateUse this when someone asks to create a MultiLocalenew localization project with a given name and languages. Returns the new project with its default locale and optionallocales; additionalif locales.the Refusesname tois createtaken ait duplicatereturns projectalready-exists nameand increates thenothing. authenticatedNot organization.for adding a language to an existing project.

 ⟨5 unchanged words⟩ ,"properties":{"defaultLocale":{"description":"Default localeLocale code forof the project (forsource examplelanguage, such as en)","maxLength":35,"minLength":1,"type":"string"},"locales":{"description":"InitialOther locale codes.codes Theto start with, such as it or de; the default locale is added automatically when omitted.","items":{"maxLength":35,"minLength" ⟨6 unchanged words⟩ :"array"},"name":{"description":"NewName of the new project, name1 (prefer

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"AddCreate a localization project"}

Delete keya andstring allin translationsevery language

PermanentlyUse deletethis everywhen localesomeone translationasks forto oneremove a key infrom atheir project.translations. IfReturns ahow phrasemany islanguage sharedrows withwere deleted and which other projects, thisshared deletesthem; thea shared rowstring is deleted permanently for those projects too,too. ratherNot thanfor removing only detachingone thelanguage's project.translation.

 ⟨6 unchanged words⟩ :{"key":{"description":"Exact key whose complete localeto groupdelete shouldin beevery deletedlanguage","maxLength":256,"minLength":1,"type ⟨2 unchanged words⟩ {"description":"Project id or name that containshas the key to delete","maxLength":128,"minLength":1,"type ⟨6 unchanged words⟩ 

 ⟨22 unchanged words⟩ type":"null"}]},"sharedProjects":{"description":"Other projects the deleted string was also removed from","items":{"maxLength":128,"type":"string ⟨18 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Delete keya andstring allin translationsevery language"}

Export localeone dictionarylanguage's strings

ExportUse onethis localewhen ofsomeone awants MultiLocalethe projectkey asand bounded,value sortedpairs key/valueof entries.one Resultslanguage, arefor API-paginatedexample withto review or copy a maximumtranslation offile. Returns up to 50 entries per call and(25 eachby valuedefault) issorted cappedby atkey, values cut to 500 characters.characters, with nextSkip for the next page. Not for a complete file download, which the MultiLocale CLI provides.

 ⟨5 unchanged words⟩ ,"properties":{"language":{"description":"LanguageLocale code to export, (forsuch example,as en)","maxLength":35,"minLength":1,"type":"string"},"limit":{"description":"MaximumEntries numberto ofreturn, keysfrom 1 to return.50; Defaultsdefaults to 25, capped at 50.","exclusiveMinimum":0,"maximum":50,"type":"integer"},"project":{"description":"Project namename; (slug)an to

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"entries":{"description":"Key and value pairs sorted by key, values cut to 500 characters","items":{"additionalProperties":false,"properties":{" ⟨32 unchanged words⟩ :"#/properties/skip"},{"type":"null"}],"description":"Pass as skip to get the next page; null on the last page"},"offsetCapReached":{"type":"boolean"}, ⟨42 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Export localeone dictionarylanguage's strings"}

Find duplicate default-localesource copystrings

FindUse keysthis inwhen asomeone boundedwants scanto ofclean oneup MultiLocalea project whoseby default-localefinding translationskeys havethat repeat the same value.default-language Thetext. resultReturns explicitlyup reportsto when25 repeated values with the scankeys orthat outputshare previewthem, isscanning truncated.1,000 default-locale strings by default and at most 2,000. Not for untranslated strings.

 ⟨6 unchanged words⟩ project":{"description":"Project id or name whose default-locale copy should be checked","maxLength":128,"minLength":1,"type":"string"},"scanLimit":{"description":"Maximum default-localeDefault-locale phrasesstrings to scan.scan, Defaultsfrom 1 to 1000,2000; cappeddefaults atto 2000.1000","exclusiveMinimum":0,"maximum":2000,"type ⟨5 unchanged words⟩ 

 ⟨19 unchanged words⟩ ,"type":"integer"},"duplicates":{"description":"Up to 25 default-locale values used by more than one key, with up to 10 keys each and the other projects sharing them","items":{"additionalProperties":false,"properties":{" ⟨99 unchanged words⟩ 

 ⟨6 unchanged words⟩ ,"readOnlyHint":true,"title":"Find duplicate default-localesource copystrings"}

ReportUse missingthis keyswhen insomeone aasks boundedwhich scanstrings ofare not translated yet, or how complete each language is. Returns completion percentages and up to 25 missing keys per locale, for one locale or up to 10 configured locales, compared with the project default locale. The resultNothing explicitlyis reportstranslated partialor localewritten. orNot phrasefor scansfilling andin neverthe createsmissing translations.

 ⟨5 unchanged words⟩ ,"properties":{"language":{"description":"LocaleOne locale code to check.check; Omitomit to report coverage forcheck everythe configured locale.locales","maxLength":35,"minLength":1,"type":"string"},"localeLimit":{"description":"MaximumHow many configured locales to check when language is omitted.omitted, Defaultsfrom 1 to 10.10; defaults to 10","exclusiveMinimum":0,"maximum":10,"type":"integer"},"project":{"description":"Project id or name whose translation coverage should be checked","maxLength":128,"minLength":1,"type":"string"},"scanLimit":{"description":"

 ⟨12 unchanged words⟩ type":"null"}]},"locales":{"description":"One row per checked locale with its completion and up to 25 missing keys; status partial means a scan cap was reached","items":{"additionalProperties":false,"properties":{" ⟨127 unchanged words⟩ 

GetShow phraseone string's translations

FetchUse translationsthis forwhen someone asks how one exact phrase key is translated, in aevery MultiLocalelanguage project.or in one. Returns athat boundedkey's Markdowntext andper structuredlocale, previewup acrossto 24 locales and 2,000 orcharacters each, with machine-translation flags and the projects sharing it, and renders a singlephrase localecard. whenNot languagefor issearching provided.keys by text.

 ⟨5 unchanged words⟩ properties":{"key":{"description":"Exact phrase key to, lookmatched upcase-sensitively","maxLength":256,"minLength":1,"type":"string"},"language":{"description":"LanguageOne codelocale tocode fetchsuch (e.g.as en, it). Omit to fetchor allit; languagesevery forlanguage thewhen

 ⟨25 unchanged words⟩ ,"type":"integer"},"translations":{"description":"One row per locale, up to 24, values cut to 2,000 characters; projects lists every project sharing the row","items":{"additionalProperties":false,"properties":{" ⟨76 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetShow phraseone string's translations"}

Get project details

FetchUse athis singlewhen MultiLocalesomeone asks about one localization project, bysuch idas which languages it has or name.its Returnsdefault boundedlocale. MarkdownReturns andthe structuredproject's projectid, metadataname, includingdefault namelocale, configured locales, and timestamps.creation and edit times. Not for how complete its translations are.

 ⟨6 unchanged words⟩ "projectIdOrName":{"description":"Project id or project name (slug)","maxLength":128,"type":"string"} ⟨4 unchanged words⟩ 

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

List phrasesa project's strings

ListUse this when someone asks to see the translation phrasesstrings forin a MultiLocale project.project, Optionallyoptionally filterin byone language or key.for Returnsone akey. boundedReturns Markdownup andto structured100 previewphrases ofwith id, key, language, and value.value, plus the total count. Not for finding strings by the words they contain.

 ⟨5 unchanged words⟩ ,"properties":{"key":{"description":"FilterOnly bythis exact phrase key","maxLength":256,"type":"string"},"language":{"description":"FilterOnly bystrings languagein this locale code, (e.g.such as en, it, es)or pt-BR","maxLength":35,"type":"string"},"project":{"description":"Project name (slug)name; toan listid phrasesmatches

 ⟨9 unchanged words⟩ ,"type":"integer"},"phrases":{"description":"Up to 100 phrases, one row per key and language, values cut to 2,000 characters; phraseCount has the total","items":{"additionalProperties":false,"properties":{" ⟨86 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List phrasesa project's strings"}

List your localization projects

ListUse allthis MultiLocalewhen projectssomeone theasks authenticatedwhich userlocalization hasprojects accessthey to.have in MultiLocale. Returns aeach boundedproject's Markdownid, andname, structureddefault previewlocale, oflanguages projectand idstimestamps, names,up locales,to and100 timestamps.projects. Not for listing the strings inside a project.

 ⟨9 unchanged words⟩ ,"type":"integer"},"projects":{"description":"Up to 100 projects; projectCount has the total","items":{"additionalProperties":false,"properties":{" ⟨72 unchanged words⟩ 

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

List teamyour membersteam

ListUse athis boundedwhen rostersomeone forasks thewho authenticatedis on their MultiLocale organization.team Returnsor onlywhat role each person has. Returns each member's display name and role. Email addressesrole, memberup IDs,to role100 IDs,members phone,(no countryemails, andids signupor devicecontact details). areNot excluded.for inviting or removing people.

 ⟨9 unchanged words⟩ ,"type":"integer"},"members":{"description":"Display name and role only. Email addresses, member ids, role ids, phone, country and signup device details are never returned.","items":{"additionalProperties":false,"properties":{" ⟨39 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List teamyour membersteam"}

Search phrasesstrings by text

SearchUse translationthis phraseswhen forsomeone aasks MultiLocaleto projectfind bytranslation matchingstrings athat querycontain stringa againstword or phrase, in their keys andor values.text. Returns aup boundedto Markdown100 matches with id, key, language and structuredvalue previewfrom ofa matchingcase-insensitive ids,match keys,within languages,one andproject. values.Not for one exact key.

 ⟨5 unchanged words⟩ ,"properties":{"language":{"description":"RestrictOnly search to athis specificlocale languagecode; codeevery (e.g.language en,when it)absent","maxLength":35,"type":"string"},"project":{"description":"Project name (slug)name; toan searchid phrasesmatches innothing","maxLength":128,"type":"string"},"query":{"description":"Search text

 ⟨9 unchanged words⟩ ,"type":"integer"},"phrases":{"description":"Up to 100 matching phrases, values cut to 2,000 characters; phraseCount has the total","items":{"additionalProperties":false,"properties":{" ⟨87 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Search phrasesstrings by text"}

Share keya string with other projects

AttachUse everythis localewhen translationsomeone forasks oneto keyreuse a key's translations in aother sourceprojects, projectsuch toas onea orcommon morebutton label. Returns the target projects.projects Theand underlyinghow phrasemany language rows becomewere sharedattached, soup futureto 25 targets; later edits affectto that string apply in every attached project. Not for a copy that can differ per project.

 ⟨6 unchanged words⟩ key":{"description":"Exact key to share, acrosswith everyall localeof its languages","maxLength":256,"minLength":1,"type":"string"},"project":{"description":"Source projectProject id or name that already containshas the key","maxLength":128,"minLength":1,"type":"string"},"targetProjects":{"description":"One or1 moreto target25 project ids or names to attach to the key to","items":{"maxLength":128,"minLength" ⟨15 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Share keya string with other projects"}

Show MultiLocale project overview

RenderUse athis boundedwhen overviewsomeone forwants a known MultiLocale project. Use this after listing projectsquick oroverview whenof theone userof providestheir alocalization projectprojects. idReturns oran name.overview Itcard showswith safethe projectproject's metadatadefault andlocale, up to 24 configured locales withoutand downloadingtimestamps. theNot projectfor phrasetranslation dictionary.completeness.

 ⟨3 unchanged words⟩ ,"properties":{"projectIdOrName":{"description":"MultiLocale projectProject id or name (slug) to render","maxLength":128,"minLength":1,"type ⟨5 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Show MultiLocale project overview"}

UpdateEdit phrasea translation

UpdateUse thethis translationwhen valuesomeone forasks ato specificfix phraseor keychange andthe languagetext inof aone MultiLocalekey project.in Phrasesone maylanguage. beReturns sharedthe acrossprevious projectsand —new updatingtext affectsand allthe projects sharing that sharestring; the key.change Clearsapplies machine-translationin flagsall sinceof thethem valueand ismarks nowthe text as human-edited. Not for adding a new key.

 ⟨5 unchanged words⟩ properties":{"key":{"description":"Exact phraseexisting key to update","maxLength":256,"minLength":1,"type":"string"},"language":{"description":"LanguageLocale code of the translation to updatechange, (e.g.such as en, it,or es)it","maxLength":35,"minLength":1,"type":"string"},"project":{"description":"Project name (slug)name; thean phraseid belongsmatches tonothing","maxLength":128,"type":"string"},"value":{"description":"New translation value

 ⟨27 unchanged words⟩ ,"type":"string"},"sharedProjects":{"description":"Every project using this string; the change applies to all of them","items":{"maxLength":128,"type":"string ⟨29 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"UpdateEdit phrasea translation"}

UpdateChange project languages or context

UpdateUse athis MultiLocalewhen project’ssomeone asks to change a project's default locale, completereplace localeits list of languages, or set its translation context. ProjectReturns nameswhich arefields intentionallychanged. notThe changedlanguage becauselist phrasesis referencereplaced as a whole, no strings are translated or deleted, and the project name.name stays fixed. Not for adding a language with its translations.

 ⟨5 unchanged words⟩ ,"properties":{"context":{"description":"Optional translationTranslation context for the project.whole Useproject, up to 600 characters; an empty string to clearclears it.it","maxLength":600,"type":"string"},"defaultLocale":{"description":"New default locale code.code; Itit musthas to be one of the projectproject's locales.locales","maxLength":35,"minLength":1,"type ⟨2 unchanged words⟩ {"description":"Complete replacement list of locale codes.codes, Include

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"UpdateChange project languages or context"}