swap3d-openapi

About this project

Swap3D OpenAPI is the official machine-readable specification for the public Swap3D developer API. It defines the API contract used by the Swap3D CLI and future SDKs, focusing on core conversion operations while excluding internal endpoints like dashboard or billing. The specification is versioned and validated to ensure consistency between the documented contract and deployed behavior. Key features include endpoints for checking supported formats, retrieving usage metrics, submitting 3D model conversions, and tracking job status. The API uses Bearer token authentication with Swap3D API keys and follows a strict change management process—breaking changes require a new API version. The repository includes validation tools to ensure the OpenAPI specification remains accurate and up-to-date. To get started, developers need Node.js 22.12 or newer. Running `npm ci` installs dependencies, while `npm test` validates the contract, generates a bundled specification (`dist/openapi.yaml`), and checks for consistency with the committed `openapi.json` artifact. Contributors must align changes with the deployed `swap3d-studio` implementation before updating the specification. The project is licensed under Apache-2.0.

This is a GitHub repository (source code), not a hosted HTTP API endpoint.

From the docs

Snippets taken from the repository README when available.

npm ci
npm test