API reference
Interactive API referenceBrowse schemas and try requests with Scalar.
Download OpenAPIUse the public OpenAPI 3.1 document in your tooling.
Base URLs
Section titled “Base URLs”| Service | Base URL |
|---|---|
| QA | https://api.qa.streakline.dev |
| Production | https://api.streakline.dev |
Choose credentials for the intended service and project environment. OAuth discovery is available from the API host; token exchange uses /api/auth/oauth2/token.
User-bound operations
Section titled “User-bound operations”These routes require a short-lived client credential issued by your authenticated backend:
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/sdk/model |
Fetch the active scoring model |
| POST | /api/v1/events/batch |
Submit events for the bound user |
| GET | /api/v1/me/profile |
Read the bound user’s profile |
Server operations
Section titled “Server operations”These routes require an OAuth M2M token with the indicated scope:
| Method | Path | Scope |
|---|---|---|
| POST | /api/v1/client-credentials |
client_credentials:issue |
| POST | /api/v1/events |
events:write |
| POST | /api/v1/events/batch/server |
events:write |
| GET | /api/v1/users/{userId}/profile |
profiles:read |
| PUT | /api/v1/users/{userId}/profile |
profiles:write |
| GET | /api/v1/users/{userId}/events |
events:read |
| GET | /api/v1/users/{userId}/achievements |
profiles:read |
| DELETE | /api/v1/users/{userId} |
profiles:delete |
| POST | /api/v1/store/purchases |
store:purchase |
Request conventions
Section titled “Request conventions”Send JSON request bodies with Content-Type: application/json. Supply Authorization: Bearer <token> for protected routes. Path user IDs refer to your application’s internal user UUID.
The interactive reference provides parameter constraints, request bodies, success schemas, and error responses for all twelve operations. See events and retries for application-level handling and authentication for issuing tokens.