Client API Overview
Flexsee exposes a lightweight REST surface for partners and advanced merchants. All endpoints live under /client/* and require an API key.
Authentication
- Provide the key via
X-Flexsee-Api-KeyorAuthorization: Bearer. - Keys are generated in the dashboard (Getting started → API Keys).
- The backend guard validates the key, records usage (prefix + label), and injects the organization context into the request.
Example:
curl -H "X-Flexsee-Api-Key: fk_cf61f0396ef57eed8aa0971f50718cae75ffc277af4acb3a" \
https://api.flexsee.ai/client/models
Error responses
| Status | Description |
|---|---|
| 401 | Missing or invalid key |
| 429 | (Future) Usage limit exceeded |
| 500 | Unexpected server error (check response body) |
Base URL
- Production:
https://api.flexsee.ai - Staging (internal):
https://api.dev.flexsee.ai
Available endpoints
| Method | Path | Description |
|---|---|---|
GET | /client/models | List models available to the organization |
POST | /client/predict/:modelName | Request predictions from a named model |
More endpoints (training, usage reporting) will be published as they stabilize.
Rate limits & usage tracking
- Calls are currently soft-limited; the platform records usage via the API key prefix and model metadata.
- Dashboard Settings → Billing supports subscriptions and pay-as-you-go wallet top-ups via Stripe Checkout.
- API-level metered billing headers (e.g.
X-Flexsee-Usage-Remaining) are not yet published onclientroutes.
SDKs & tooling
- A TypeScript SDK and Postman collection are planned. For now, standard HTTP clients or cURL suffice.
- The Docusaurus site (this doc) will host example code samples for popular languages as they become available.