# Getting started

Getting started with the Sublime Ads API is easy.

First you will need your API key. This can be found on your account page, under API Keys.

API Keys

At the moment you can only use one API key.

To copy, just click/tap the box and use the usual copy command for your operating system.

Each time you call the API you need to append your token in your query string.

We'll call the API Key a "token" from now on to avoid confusion.

# Hello Sublime Ads

To test your token you can call the following endpoint:


Pass in your token as a URL parameter:


On success the API will return a 200 OK and a message welcoming you with your given name. A timestamp is also provided. Here is an example reply:

{"message":"Hello from Sublime Ads, Vincent! 🖖","now":"2020-06-11T17:17:34.026Z"}

Feel free to use this endpoint to check for availability of Sublime Ads and validity of your token.