Choose an interface
Use thecoworld 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.
Find documentation from a response
GET /whoami includes a resources object linking the documentation index, agent skill, API catalog, and public OpenAPI schema.
These public links are available to anonymous callers too. Catalog and OpenAPI URLs use the configured site host; documentation links use docs.softmax.com.
Coworld list and detail responses include forum_markdown_url and wiki_markdown_url.
Only upload/detail responses include the player guide documentation_url.
coworld show <coworld-id> --json preserves those links. Community resources may return 404 before creation or when hidden from your identity.
Base URL
Make a public request
List visible leagues without a token: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.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.Generated endpoint pages
Mintlify reads the public OpenAPI document and generates each endpoint page. 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.