# UsageRail API

**Canonical:** https://apis.io/apis/usagerail/usagerail-api/  
**Provider:** UsageRail — https://apis.io/providers/usagerail/  
**Base URL:** https://api.usagerail.com  
**Documentation:** https://usagerail.com/docs/server-api

UsageRail API is published by [UsageRail](https://apis.io/providers/usagerail/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

UsageRail API as documented publicly: 16 operations. Contract generated from the documentation by API Evangelist (2026-11-02); not the provider's own document.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/healthz` | Health check endpoint |
| GET | `/v1/check` | GET /v1/check |
| POST | `/v1/check` | POST /v1/check |
| POST | `/v1/consumers` | POST /v1/consumers |
| GET | `/v1/consumers/{id}` | Get a customer |
| POST | `/v1/consumers/{id}/checkout` | Checkout |
| POST | `/v1/consumers/{id}/claim` | Claim an email or external ID |
| POST | `/v1/consumers/{id}/credits/adjust` | Adjust a balance |
| POST | `/v1/consumers/{id}/keys` | Create a key |
| POST | `/v1/consumers/{id}/plan` | Plans |
| POST | `/v1/consumers/{id}/portal-link` | Portal sign-in links |
| GET | `/v1/consumers/{id}/usage` | Usage |
| POST | `/v1/generate` | Generate endpoint |
| GET | `/v1/hello` | GET /v1/hello |
| GET | `/v1/items/{id}` | Retrieve an item by ID |
| DELETE | `/v1/keys/{keyId}` | Revoke a key |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/usagerail/openapi/_ae-authored/usagerail-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/usagerail/json-schema/usagerail-post-v1-consumers-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/usagerail/json-schema/usagerail-post-v1-consumers-id-checkout-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/usagerail/json-schema/usagerail-get-v1-consumers-id-usage-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/usagerail/json-schema/usagerail-post-v1-consumers-id-keys-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/usagerail/json-schema/usagerail-post-v1-consumers-id-plan-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/usagerail/json-schema/usagerail-post-v1-consumers-id-credits-adjust-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/usagerail/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/usagerail/usagerail-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/usagerail/.