This repo holds the documentation for the Venice API. The doc-site itself is built using Mintlify, providing a clean, modern interface for exploring our API capabilities.
Our documentation is organized into several key sections:
- Docs - Overview, getting started, and the capability guides for text, image, video, audio, search, and integrations
- Models - The model catalog, by modality
- Learn - Complete, runnable walkthroughs and projects built on the API
- API Reference - Endpoint documentation generated from
swagger.yaml - Changelog - Latest updates and API changes
- Status Page - Live service status
- Node.js installed on your system
!! Make sure you're on the node version specified in the
.nvmrcfile.
- Clone this repository and navigate to the project directory:
git clone git@github.com:veniceai/api-docs.git
cd api-docs- Install dependencies:
yarn- Start the development server:
yarn devThe documentation will be available at http://localhost:3000.
- Edit
.mdxfiles to modify the documentation content - Update
docs.jsonto configure site navigation and metadata - Place images and assets in the corresponding directories
- Reference the OpenAPI specification in
swagger.yamlfor API details
Translations: Edit English source pages only. Mintlify regenerates locale copies after merge to main. Do not hand-edit every locale in the same PR unless you are intentionally updating all translations. When adding a new nav page, add the English path in docs.json only — not {locale}/... paths until translations exist.
- 🎨 Clean, modern UI with customizable theming
- 📱 Responsive design for all devices
- 🔍 Full-text search capabilities
- 🚦 Interactive API request builder
- 📊 OpenAPI specification integration - Swagger
- 🌙 Dark/light mode support
Changes are automatically deployed when pushed to the main branch. Just:
- Push changes to your default branch
- Your documentation will automatically update at your deployment URL
Pull requests get a Mintlify preview deployment, linked from the checks on the PR, so a reviewer can read the rendered pages without pulling the branch. Mintlify also runs a link-rot check and a spellcheck on each PR. Testing locally with yarn dev is still the fastest loop while you are writing.
If you encounter any issues:
- 404 Errors: Ensure you're running the dev server in a directory containing
docs.json - Development Server Issues: Run
yarn installto reinstall dependencies - Content Not Updating: Clear your browser cache or try a hard refresh
- Create a new branch for your changes
- Make your updates to the documentation
- Test locally using
yarn dev - Submit a pull request with a clear description of your changes
Built with Mintlify