Get started

Authentication

Send your API key in the Authorization header of each request, as a bearer token:

Terminal
curl https://roterminal.co/api/v1/me \
  -H "Authorization: Bearer $ROTERMINAL_API_KEY"

Getting a key

Create keys in Settings → Developer. You can have up to 20, so give each place you use one its own key, like “My server” and “Discord bot”. A key is shown once, when you create it. If you lose it, delete it and create a new one.

Keys start with rta_. Settings shows each key’s last four characters, when it was created and when it was last used, so you can tell them apart.

Without a key

Every endpoint except List your games works without a key. Without one you get 50 calls a day for each address, which is enough to try things. A key counts your calls on your account instead, and gives you your plan’s calls a day. See Rate limits.

Keep your key secret

  • Use it from your server, never from code that runs in someone’s browser or app, where anyone can read it.
  • Keep it in an environment variable, like ROTERMINAL_API_KEY, not in your code or a repository.
  • If a key gets out, delete it in Settings → Developer. It stops working at once.

A request with a key that doesn’t exist, or was deleted, gets a 401 with the code invalid_api_key. It isn’t answered as if it had no key.

Keys made for you

When you sign in from the CLI with roterminal login, or connect RoTerminal to Claude or ChatGPT, RoTerminal makes a key for that app. Those keys are listed in Settings → Developer too, with the app’s name, and you can disconnect any of them there.

Check a key

Retrieve your account tells you whose key it is, its plan and how many calls are left today. It doesn’t count as a call.