The Platform APIs give you programmatic access to your Simplismart organisation. Use them to monitor deployment health, track token usage and costs, pull metrics into your own observability stack, browse models, and keep an eye on alerts and batch jobs, all with the same API key you use for inference.

​
What you can do

Monitor deployments

List deployments, check status and health, and inspect configuration across clusters.

Track usage

Analyse token usage and API token activity, with breakdowns by user and model.

Observe metrics

Federate deployment metrics into Prometheus or Grafana.

Explore models and alerts

Browse model repositories and catalogues, and view alert rules, channels and batch jobs.

​
Authentication

Send your API key as a Bearer token. You can generate one under Settings → API Keys (see API key generation).
The token determines your organisation. Requests are evaluated with the permissions of the user who created the token, so a token can only see what that user can see. Authentication failures return 401 {"detail": "..."} and permission failures return 403 {"detail": "..."}.

​
Conventions

  • Workspaces. Many endpoints accept workspace_id (or workspaceId). When omitted, your organisation’s default workspace is used. Passing it explicitly is recommended.
  • Unknown parameters in the query string or JSON body are ignored.
  • Pagination. Only endpoints that document limit/offset or count/offset are paginated; others return the full list.
  • Error shape. Most errors are {"error": "..."}; some return {"detail": "..."} or a field map such as {"workspace_id": ["..."]}.
  • Some usage endpoints use POST because they take a structured query body.

​
Endpoint groups

Use the sidebar to browse each endpoint: