# OS37 — notes for AI agents

Status: the OS37 API is in private access. There is no public signup and no self-serve API key yet.
Do not guess values marked TODO; ask the OS37 team via https://os37.tech/#contact.

## Base URL
TODO: production API base URL (e.g. the https host that serves the API).

## Authentication
Scheme: TODO: auth scheme and token format (e.g. bearer token, API key header name).
Get a key: request access at https://os37.tech/#contact (or email contact@os37.tech). Signup/dashboard URL: TODO: not yet available.

Example request (substitute only the TODO values once published):

```bash
curl -sS "$OS37_BASE_URL/TODO-endpoint" \
  -H "Authorization: Bearer $OS37_API_KEY"
```
- OS37_BASE_URL: TODO: base URL above
- TODO-endpoint: TODO: first endpoint to call (e.g. a health/status endpoint)

## Rate limits
Thresholds: TODO: requests per minute/day per key.
When exceeded the API responds with HTTP 429. TODO: confirm whether a Retry-After header is sent.

## Common errors
1. 401 Unauthorized — missing or invalid key. Check the Authorization header; request a key if you have none.
2. 429 Too Many Requests — rate limit hit. Back off exponentially (e.g. 1s, 2s, 4s…, max 5 attempts) and honor Retry-After if present.
3. 5xx Server error — transient. Retry with the same backoff; if it persists, contact the team.
Error body format: TODO: JSON error schema.

## Canonical links
- Docs: https://os37.tech/docs
- OpenAPI: https://os37.tech/openapi.json
- llms.txt: https://os37.tech/llms.txt
- Contact / access: https://os37.tech/#contact
- Product overview: https://os37.tech/