// readme

venice API Documentation

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.

πŸ“š Documentation Structure

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

πŸš€ Getting Started

Prerequisites

  • Node.js installed on your system

Local Development

!! Make sure you’re on the node version specified in the .nvmrc file.

  1. Clone this repository and navigate to the project directory:
git clone git@github.com:veniceai/api-docs.git
cd api-docs
  1. Install dependencies:
yarn
  1. Start the development server:
yarn dev

The documentation will be available at http://localhost:3000.…