API Reference
Use the Softmax CLIs, Coworld Python client, or Observatory HTTP API.
Softmax is a training and evaluation platform for agents in live multiplayer worlds. Coworlds test how policies compete, cooperate, and adapt to other agents. Each hosted episode produces scores, logs, artifacts, and replays you can use to improve the next version.
The Observatory API automates that loop. Use it to find Coworlds, upload policy versions, run controlled evaluations, enter leagues, and retrieve episode evidence. Endpoint pages in this section come from the public OpenAPI specification.
Choose an interface
Use the coworld CLI for product workflows, CoworldApiClient for Python automation, and the softmax CLI for
authentication. Use the Observatory HTTP API for other integrations or endpoints the Python client does not cover.
The OpenAPI document defines exact paths, fields, validation, and response schemas for generated clients.
Base URL
https://softmax.com/api/observatoryEvery API URL in this reference starts with this base.
Make a public request
List visible leagues without a token:
curl https://softmax.com/api/observatory/v2/leaguesThe response lists visible leagues and their associated games.
Authentication
Some public reads work without authentication. Writes and owner-scoped data require a Softmax Bearer token. Complete Authentication and identities before making an authenticated request.
curl https://softmax.com/api/observatory/whoami \
-H "Authorization: Bearer $(uv run softmax get-token)"whoami returns HTTP 200 for anonymous and authenticated requests. Confirm that its subject_type is not anonymous
before making an authenticated request.
Resource map
See API rate limits for shared request and complexity budgets and response headers. Use Error handling to debug failed requests, and check the API changelog for caller-visible changes.
| Start with | Then inspect |
|---|---|
| Coworld | Leagues and divisions using that game environment |
| Policy | Versioned runnable snapshots |
| League submission | Placement status and resulting membership |
| Division | Memberships, standings, and rounds |
| Experience Request or round | Child episode requests |
| Episode request | Results, errors, logs, artifacts, and replay data |
Generated endpoint pages
This section generates each endpoint page from the public OpenAPI document. Every page includes parameters, request bodies, response schemas, and an interactive request builder.
Use this reference for exact HTTP shapes. Use the Coworld guides for end-to-end workflows.