6th Floor Studios

This is the OpenAPI 3.1 compliant description for [Teekey](https://teekey.ch/)'s API.

At Teekey, translation efforts are typically consolidated under a **project**. This entity regroups **segments** (unique references
to a piece of content), **locales** (the languages you translate content to) and **localizations** (the translations themselves).

When you create a project in Teekey's web UI, an API key will automatically be made available under _Project Settings_.
Our API expects this key as Bearer token, hence why the RESTful structure of requests is implicitly scoped to the given project.

The Teekey API doesn't support bulk updates. For simplicity's sake, **PATCH** routes are not listed despite being valid. We also
accept partial payloads via **PUT** and complete payloads via **PATCH** to accomodate most libraries.

You can work on only one object per request. All API requests must be made over HTTPS.
Calls made over plain HTTP will fail. API requests without authentication will also fail.

Teekey API Reference

Project

Retrieve information about the current project based on Bearer API key

Show project details

Update project details like name and description

Update project attributes

Retrieve standard .tk file contents

Returns a ZIP file containing YAML files for each locale and its localizations

Export project as zip

Segment

Returns a list of all segments in the project. Use the optional 'items' parameter to paginate. This list will not return associated localization ids.

List all segments

Create a new segment

Get segment and localization ids

Update a segment attributes

Delete a specific segment

The languages you're translating from and to

Locale

Get all locales

Create a new locale

Get a specific locale

Update a locale attributes

Delete a specific locale

Returns a YAML file for a specific locale

Get a locale file as YAML

Localization

Returns a list of all localizations in the project. Use the 'items' parameter to paginate.

List all localizations

Get a specific localization

Update a specific localization

Teekey API

Teekey

<p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">The Teekey API is organized around </strong><a href="https://en.wikipedia.org/wiki/Representational_state_transfer" target="_blank">REST</a><strong class="slate-bold">. Our API has predictable resource-oriented URLs, accepts </strong><a href="https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms" target="_blank">form-encoded</a><strong class="slate-bold"> request bodies, returns </strong><a href="https://www.json.org/json-en.html" target="_blank">JSON-encoded</a><strong class="slate-bold"> responses, and uses standard HTTP response codes, authentication, and verbs.</strong></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold"></strong></p><p class="slate-p" placeholder="Type / for widgets">At Teekey, translation efforts are typically consolidated under a<strong class="slate-bold"> </strong><a href="https://app.theneo.io/6th-floor-studios/Teekey/project/" target="_self">project</a>. This entity regroups<strong class="slate-bold"> </strong><a href="https://app.theneo.io/6th-floor-studios/Teekey/segment/" target="_self">segments</a> (unique references
to a piece of content),<strong class="slate-bold"> </strong><a href="https://app.theneo.io/6th-floor-studios/Teekey/locale/" target="_self">locales</a> (the languages you translate content to) and <a href="https://app.theneo.io/6th-floor-studios/Teekey/localization/" target="_self">localizations</a> (the translations themselves).</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">When you create a project in Teekey&apos;s web UI, an API key will automatically be made available under <em class="slate-italic">Project Settings</em>.
Our API expects this key as Bearer token, hence why the RESTful structure of requests is implicitly scoped to the given project.</p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">The Teekey API doesn&apos;t support bulk updates. For simplicity&apos;s sake, <strong class="slate-bold">PATCH</strong> routes are accepted but not listed.</p><p class="slate-p" placeholder="Type / for widgets">We also accept partial payloads via <strong class="slate-bold">PUT</strong> and complete payloads via <strong class="slate-bold">PATCH</strong> to accomodate most libraries.</p></div></div><div  data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">You can work on only one object per request. All API requests must be made over HTTPS. </p><p class="slate-p" placeholder="Type / for widgets">Calls made over plain HTTP will fail. API requests without authentication will also fail.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

. Our API has predictable resource-oriented URLs, accepts 

 responses, and uses standard HTTP response codes, authentication, and verbs.

At Teekey, translation efforts are typically consolidated under a

 (unique references
to a piece of content),

 (the languages you translate content to) and 

When you create a project in Teekey's web UI, an API key will automatically be made available under 

.
Our API expects this key as Bearer token, hence why the RESTful structure of requests is implicitly scoped to the given project.

200 - OK

The request was unacceptable, often due to missing a required parameter.

400 - Bad request

The request was unacceptable, often due to invalid or missing Bearer token.

401 - Unauthorized

404 - Not Found

The entity could not be processed, validation failed.

422 - Unprocessable Entity

<p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">This is the root object of your API calls, implicitly defined by your Bearer API key. You can retrieve and update it basic information, export all its translations in a structured file format as archive, or get the contents for the .tk file our standard libraries will use to perform other actions.</strong></p><p class="slate-p" placeholder="Type / for widgets"></p>

This is the root object of your API calls, implicitly defined by your Bearer API key. You can retrieve and update it basic information, export all its translations in a structured file format as archive, or get the contents for the .tk file our standard libraries will use to perform other actions.

<p class="slate-p" placeholder="Type / for widgets">Retrieve information about the current project based on Bearer API key</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Authorization

object

name

description

created

updated

errors

<p class="slate-p" placeholder="Type / for widgets">Update project details like name and description</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Our standard libraries will typically save the contents to a local .tk file in the current directory, and reuse its contents to perform further calls.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Our standard libraries will typically save the contents to a local .tk file in the current directory, and reuse its contents to perform further calls.

project

List of project's files, with their ID and a relative path for serialization

files

<p class="slate-p" placeholder="Type / for widgets">Returns a ZIP file containing YAML files for each locale and its localizations</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">A segment, also known as a translation key, is the unique reference for a given piece of content which will be translated across the project&apos;s languages. The segment key is traditionally named with dots like </strong><code class="slate-code"><strong class="slate-bold">general.key.example</strong></code><strong class="slate-bold">, which gives structure to your content and creates more concise files when using formats such as YAML and JSON.</strong></p><p class="slate-p" placeholder="Type / for widgets"></p>

A segment, also known as a translation key, is the unique reference for a given piece of content which will be translated across the project's languages. The segment key is traditionally named with dots like 

, which gives structure to your content and creates more concise files when using formats such as YAML and JSON.

<p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">A locale represents a language variant you will be translating your content to. At Teekey, locales have some special attributes :</strong></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">language is a shortand name for the locale and will generally be used to name the exported file</div></li><li class="slate-li"><div style="position:relative">a language can be a variant of another, in a hierarchical way. If the variant language only has a few regionalisms, you can override these translations only, and leverage fallback mechanisms in the project using your content</div></li><li class="slate-li"><div style="position:relative">an optional locale code (our currently accepted codes can be found <a href="https://github.com/umpirsky/locale-list/blob/master/data/en/locales.yaml" target="_blank">here</a>), which can be used as standardized reference, and is necessary to leverage automated translation in our web UI through DeepL or Google Translate.</div></li><li class="slate-li"><div style="position:relative">finally a display name, which you can customize to your liking and only serves visual purposes.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

A locale represents a language variant you will be translating your content to. At Teekey, locales have some special attributes :

<p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">A localization is the translated content of a given </strong><a href="https://app.theneo.io/6th-floor-studios/Teekey/segment/" target="_self">segment</a><strong class="slate-bold">, to a given </strong><a href="https://app.theneo.io/6th-floor-studios/Teekey/locale/" target="_self">locale</a><strong class="slate-bold">. Empty localization resources are automatically created or deleted when you add or remove segments and locales to maintain schema consistency, hence the lack of POST and DELETE actions for this resource.</strong></p><p class="slate-p" placeholder="Type / for widgets"></p>

A localization is the translated content of a given 

. Empty localization resources are automatically created or deleted when you add or remove segments and locales to maintain schema consistency, hence the lack of POST and DELETE actions for this resource.

Sections