Overview

The TurboFiles API adheres to REST principles, featuring predictable, resource-oriented URLs. It provides responses compliant with the JSON:API specification and follows standard HTTP protocols for response codes, authentication, and verbs.

Base URL

All TurboFiles API endpoints share the same base URL:

https://api.turbofiles.io

Versioning

The API incorporates version numbers as endpoint prefixes (e.g., /v1). While we maintain flexibility in development, we prioritize backward compatibility in updates.

If a breaking change is necessary, we will introduce a new major version and support the previous version during a deprecation period to ensure a smooth migration for existing integrations.

Backwards-compatible changes include:

• Adding new API resources
• Introducing optional request parameters
• Expanding API response properties
• Reorganizing response property order
• Adding new webhook event types

Rate Limiting

To monitor your rate limit status, successful responses include the following HTTP headers:

• X-Ratelimit-Limit
• X-Ratelimit-Remaining

Exceeding these limits triggers a 429 Too Many Requests response.