API reference

MaxoPerf exposes two HTTP surfaces customers can call. Both are documented as live OpenAPI references — pick the one that matches the workflow you are building.

Platform API

The Platform API is the customer-facing surface for the same workflows you do in the console: accounts, workspaces, projects, tests, runs, billing, and support. Use it from CI pipelines, scripts, and SDKs.

Open the live reference at /reference/ — that page renders every Platform API endpoint with request and response schemas, authentication, and examples. It is regenerated on every release so it always matches the API your account talks to.

Results ingest

The results ingest contract is a separate HTTPS endpoint that receives run data from authorized test engines. You normally do not call it directly — Maxoperf-managed runners and the agent you install for private datacenters handle ingest for you.

The live reference is published the same way as the Platform API. The combined reference page at /reference/ lets you switch between Platform API and results ingest from a single drop-down.

Authentication

• Platform API — bearer token issued to the calling principal. Tokens are scoped to one account.
• Results ingest — run-scoped, write-only credentials issued automatically per run.

Treat any token like a password: store it in a secret manager, rotate it regularly, and revoke any token you suspect has been exposed.

Common automation patterns

Workflow	Read this guide
Trigger a run from CI on every release candidate	Run tests from CI
Wait for a run to finish, then gate the build	Run tests from CI
Track recurring runs over time	Schedule recurring tests

Where to go next

• Public origin contract — the URLs MaxoPerf promises.
• Run tests from CI — practical example of using the Platform API.
• Status page — check operational status before debugging an API issue.