Introduction

The Lingo API is designed to allow you to access your content programatically to import, export or validate your data. In this guide we will cover what you can do with the API and how to get started.

Getting access

API Access is available for all Spaces on the Plus or enterpise plans. API access is enabled by creating an API token. You may need to upgrade your space to do this.

Creating a token

API access requires an API token. Tokens grant access to all of the content in your space including Kits, Sections, Assets and all files. Keep your tokens safe!.

Space admin can can create a token on the settings page for the desired space. All tokens are read only by default but write access can enabled after creation. Tokens can also be named for your reference.

Deleting a token is permanent. Once deleted any code using that token will fail to authenticate.

Using the API

There are currently two ways to interact with the API, a javascript library and the underlying REST API. The javascript library is a wrapper around the REST API and provides a more convenient way to interact with the API. The REST API is a more direct way to interact with the API and is useful if you are using a language besides javascript.

Both the javascript library and the REST API are documented in this guide. The javascript library includes additional functionality that may not be available in the API directly.