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.

​
Prerequisites

We use a token-based authorization system. Before requesting access tokens, make sure your API credentials are set up by following the API Keys guide.

​
Access Token

The platform issues short-lived access tokens used by both REST and WebSocket APIs where required. To obtain an access token, call the Get Access Token endpoint with your API credentials. Also refer to the Authorization Endpoint Rate Limit for rate limiting details.

​
Token Management

Access tokens expire every 30 minutes (expires_in = 1800 seconds). To minimize unnecessary requests and avoid rate limits:
  • Cache and reuse tokens until expiry
  • Refresh proactively a few minutes before expiration

​
Errors & Troubleshooting

  • Unauthorized (401): Verify X-Api-Key/X-Api-Secret and token validity.
  • Expired token: Refresh using the token endpoint before expires_in.
  • Excessive requests: Respect rate limits; cache tokens and refresh sparingly.