OpenAPI and Postman

Use the machine-readable contracts when building clients, test suites, monitors, or agent integrations.

OpenAPI

The OpenAPI 3 contract describes the current HTTP API, public media routes, OAuth metadata routes, MCP transport routes, and MCP HTTP gateway routes.

The contract includes route tags, request schemas, response schemas, auth schemes, and public-vs-protected route information.

Postman Collections

Workshop maintains two Postman collections in the main platform repository:

Collection Audience
Workshop API.postman_collection.json Full internal/staging collection including admin, bootstrap, OAuth, MCP transport, and unhappy-path examples
Workshop API (Public).postman_collection.json Public developer collection without internal bootstrap/admin routes

The public collection includes folder guides, happy-path examples, and unhappy-path examples for each major route group.

Before integrating against a deployment:

  1. Run GET /health without auth.
  2. Run GET /api/health with an API key.
  3. Compile a minimal .ws source.
  4. Queue a short native render.
  5. Poll GET /api/render/{id} until complete.
  6. Download GET /api/video/{id}.
  7. If using agents, mint a bearer token and call GET /api/mcp/tools.

Next Steps