Teekey

## Sections
• [Teekey API Reference](https://app.theneo.io/6th-floor-studios/Teekey/teekey-api-reference.md): The Teekey API is organized around REST . Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. 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 accepted but not listed. 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.
• [Project](https://app.theneo.io/6th-floor-studios/Teekey/project.md): 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.
  • [Show project details](https://app.theneo.io/6th-floor-studios/Teekey/project/show-project-details.md): Retrieve information about the current project based on Bearer API key
  • [Update project attributes](https://app.theneo.io/6th-floor-studios/Teekey/project/update-project-attributes.md): Update project details like name and description
  • [Retrieve standard .tk file contents](https://app.theneo.io/6th-floor-studios/Teekey/project/retrieve-standard-tk-file-contents.md): 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.
  • [Export project as zip](https://app.theneo.io/6th-floor-studios/Teekey/project/export-project-as-zip.md): Returns a ZIP file containing YAML files for each locale and its localizations
• [Segment](https://app.theneo.io/6th-floor-studios/Teekey/segment.md): 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 general.key.example , which gives structure to your content and creates more concise files when using formats such as YAML and JSON.
  • [List all segments](https://app.theneo.io/6th-floor-studios/Teekey/segment/list-all-segments.md): Returns a list of all segments in the project. Use the optional 'items' parameter to paginate. This list will not return associated localization ids.
  • [Create a new segment](https://app.theneo.io/6th-floor-studios/Teekey/segment/create-a-new-segment.md)
  • [Get segment and localization ids](https://app.theneo.io/6th-floor-studios/Teekey/segment/get-segment-and-localization-ids.md): Get a specific segment, and associated localization ids
  • [Update a segment attributes](https://app.theneo.io/6th-floor-studios/Teekey/segment/update-a-segment-attributes.md)
  • [Delete a specific segment](https://app.theneo.io/6th-floor-studios/Teekey/segment/delete-a-specific-segment.md)
• [Locale](https://app.theneo.io/6th-floor-studios/Teekey/locale.md): A locale represents a language variant you will be translating your content to. At Teekey, locales have some special attributes : language is a shortand name for the locale and will generally be used to name the exported file 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 an optional locale code (our currently accepted codes can be found here ), which can be used as standardized reference, and is necessary to leverage automated translation in our web UI through DeepL or Google Translate. finally a display name, which you can customize to your liking and only serves visual purposes.
  • [Get all locales](https://app.theneo.io/6th-floor-studios/Teekey/locale/get-all-locales.md): Returns a list of all locales in the project
  • [Create a new locale](https://app.theneo.io/6th-floor-studios/Teekey/locale/create-a-new-locale.md)
  • [Get a specific locale](https://app.theneo.io/6th-floor-studios/Teekey/locale/get-a-specific-locale.md)
  • [Update a locale attributes](https://app.theneo.io/6th-floor-studios/Teekey/locale/update-a-locale-attributes.md)
  • [Delete a specific locale](https://app.theneo.io/6th-floor-studios/Teekey/locale/delete-a-specific-locale.md)
  • [Get a locale file as YAML](https://app.theneo.io/6th-floor-studios/Teekey/locale/get-a-locale-file-as-yaml.md): Returns a standard i18n YAML file for a given locale
• [Localization](https://app.theneo.io/6th-floor-studios/Teekey/localization.md): A localization is the translated content of a given segment , to a given locale . 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.
  • [List all localizations](https://app.theneo.io/6th-floor-studios/Teekey/localization/list-all-localizations.md): Returns a list of all localizations in the project. Use the 'items' parameter to paginate (highly recommended)
  • [Get a specific localization](https://app.theneo.io/6th-floor-studios/Teekey/localization/get-a-specific-localization.md)
  • [Update a specific localization](https://app.theneo.io/6th-floor-studios/Teekey/localization/update-a-specific-localization.md)