Skip to content

Getting Started

Overview

The Management App

In order to start using the API you need to register on the Management App, login and create an API key. The following describes the usage and contant of the Management App.

1 Creating an Account

Navigate to /register (or click Register in the top navigation bar).

You will be asked to fill in two sections:

Account Information

Field Required Description
Email address Yes Used for login and notifications
Password Yes Minimum 8 characters
Confirm Password Yes Must match the password above
Full Name Yes Your display name

Company Details

Field Required Description
Company No Your organisation name
Address No Street, city, country
Phone No Contact telephone number
Billing Info No VAT number, billing address, etc.

Before submitting, you must accept the Terms of Use and Privacy Policy by checking the consent checkbox. Registration without consent is not possible.

Click Create account to submit. You will receive a confirmation email to verify your address.

Tip: You can update all company and billing details later in your Profile.

2 Email Verification

After registering, check your inbox for a verification email. Click the link inside to confirm your address.

  • If the link has expired or you did not receive the email, go to /resend-verification to request a new one.
  • You cannot log in until your email address has been verified.

Once verified, you will see a confirmation page and can proceed to sign in.

3 Logging In

Navigate to /login (or click Login in the navigation bar).

Enter your email address and password, then click Sign in.

Forgot your password?

Click Forgot your password? on the login page. Enter your email address and follow the link sent to your inbox to set a new password.

Failed login attempts

If there were failed login attempts on your account since your last successful session, the Dashboard will display a security notice informing you of the count. If the activity was not you, change your password immediately via Profile Settings.

4 The Dashboard

After logging in you are taken to /dashboard — your main overview page.

Summary Cards

Three stat cards are displayed at the top:

Card What it shows
API Keys Total number of API keys on your account; links to the Keys page
Token Balance Your current token balance (or "Unlimited" if applicable)
API Calls Today Number of API calls made today; links to the full Usage page

Recent API Usage Table

Below the cards, a table shows your last 5 API calls with:

  • Timestamp — when the call was made
  • Endpoint — which API endpoint was called
  • Status — HTTP status code (green = success, red = error)
  • Tokens — tokens charged for that call

Click View usage → to open the full Usage log with filtering options.

5 Managing API Keys

Navigate to API Keys in the navigation bar (/keys).

Key List

The table shows all your keys with:

  • Name — the label you gave the key
  • Prefix — the first characters of the key (e.g. rl_abc...) to help you identify it
  • Status — active, expired, or revoked
  • Expires — expiry date, or "Never" for non-expiring keys
  • Created — creation date

Creating a New Key

Click Create New Key (top right of the Keys page).

Fill in:

Field Required Description
Key Name Yes A descriptive label, e.g. "Production API Key"
Expiration Date No Leave empty for a key that never expires
Endpoint Permissions No Select which API endpoints this key is allowed to call

Click Create API Key.

Important: The full API key is shown only once immediately after creation. Copy it and store it securely (e.g. in a secrets manager or .env file). You cannot retrieve the full key value again after leaving this page.

Editing a Key

Active keys have an Edit link. You can update:

  • The key's name
  • The expiry date
  • Which endpoints the key has permission to call

Revoking a Key

Active keys have a Revoke button. Revoking a key is permanent — it cannot be re-activated. Create a new key if you need to replace a revoked one.

Using Your API Key

Include your key as a bearer token in the Authorization header of every API request:

Authorization: Bearer <your-api-key>

6 Viewing Your Usage

Navigate to Usage in the navigation bar (/usage).

The usage log shows a detailed, paginated history of every API call made with your keys.

Columns

Column Description
Timestamp Date and time of the request
Endpoint The API path that was called
Method HTTP method (GET, POST, etc.)
Status HTTP response status code
Success Whether the call completed successfully
Tokens Number of tokens consumed by the call
Response Time How long the server took to respond (in ms)

Filtering

Use the filter bar at the top to narrow results by:

  • From / To — a date range
  • Endpoint — a specific path (e.g. /api/v1/data)
  • Result — All, Success only, or Failed only

Click Filter to apply. The page URL updates so you can bookmark or share filtered views.

7 Profile and Settings

Navigate to Profile in the navigation bar (/profile).

Profile Information

Update your personal and billing details:

  • Email address, full name
  • Company, address, phone number
  • Billing information (VAT number, billing address, etc.)

Click Save changes to apply.

Change Password

Enter your current password and a new password (minimum 8 characters), confirm it, and click Update password.

Data Export (GDPR)

Under Data Export, click Download My Data to receive a copy of all personal data stored in the system. This fulfils your right to data portability under GDPR.

Account Deletion

The Danger Zone section lets you request account deletion. After submitting:

  • Your account is scheduled for permanent removal after a grace period.
  • During the grace period you can cancel the request by clicking Cancel Deletion Request on the same page.

Quick Reference: Page URLs

Page URL
Register /register
Login /login
Resend verification /resend-verification
Forgot password /forgot-password
Dashboard /dashboard
API Keys /keys
Create API Key /keys/create
Usage Log /usage
Profile Settings /profile
Terms of Use /terms
Privacy Policy /privacy