Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt

Use this file to discover all available pages before exploring further.

To access the Rails APIs, developers must first configure their API keys. This process is completed through the Rails UI.

​
Create a New API Key

  1. Navigate to the API Key Management tab under Settings in the Rails UI. Here, you will see your existing API keys and the option to create a new one.
API key setup: step 1
  1. Click the Create API Key button. On the following page, provide a descriptive name for your new key and confirm by clicking Create API Key.
When creating an API key, you may select the read-only option. Read-only API keys restrict access to the following User Account endpoints:Attempting to access any other endpoints or WebSocket features with a read-only API key will result in a 403 Forbidden error.
API key setup: step 2 Each API key consists of two components: the key (identifier) and the secret (authentication credential). The secret is displayed only once—be sure to copy and store it securely before confirming the creation. API key setup: step 3 After creation, your new API key will appear in the management table. To revoke a key, use the “trash can” icon under the ACTIONS column. API key setup: step 4

​
Revoke an Existing API Key

If an API key is compromised or you wish to rotate your keys periodically, click the “trash can” icon to revoke it. API key setup: step 5 Once revoked, you may generate a new API key by following the steps above.

​
Use an API Key

API keys (key and secret) are used to obtain a short-lived access token for authenticating with the Rails APIs. For details, refer to the Get Access Token endpoint. Security best practices:
  • Always access your API secrets securely (e.g., via environment variables).
  • Never commit your secrets to a code repository.