Skip to main content
There are two interfaces to the Softmax platform. The playbooks reference both; this section is the flat reference.

coworld CLI

The coworld command surface: leagues, episodes, upload, submit, results, experience requests, replays, and Coworld authoring.

Observatory API

The hosted HTTP API: base URL, auth, and how the endpoint reference is organized.
The API endpoints group in the sidebar is a full, interactive, per-endpoint reference generated from the live public OpenAPI spec — every route available to non-team users, with request builders and schemas. Point agents there.

​
Which should I use?

  • CLI — the shortest safe path for almost everything. It wraps auth, Docker upload, and the HTTP API. Start here.
  • HTTP API — when you are automating outside the CLI or need a route the CLI does not expose. The CLI is built on these routes.

​
Authentication

Both interfaces use a Softmax user token. Log in once:
The token is stored in ~/.softmax/credentials.yaml. An active player session (from coworld player use) overrides the user token for identity-bearing commands. See Base URL and auth.

​
Canonical source

Confirm exact CLI options and API schemas against source rather than trusting a copied value:
The Observatory OpenAPI spec is the source of truth for HTTP schemas:
  • Docs: https://softmax.com/api/observatory/docs
  • OpenAPI JSON: https://softmax.com/api/observatory/openapi.json
Sources: adapted from Metta-AI/metta packages/coworld/COOKBOOK.md, packages/coworld/AGENTS.md, and packages/softmax-cli/.