Skip to content

README.md

Latest commit

 

History

History
58 lines (40 loc) · 1.78 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.78 KB

Fish Audio Documentation

Fish Audio License

This repository contains the source for Fish Audio's documentation.

Fish Audio is an AI platform for voice generation, voice cloning, and audio storytelling. Our technology enables natural-sounding voices for applications across gaming, education, content creation, accessibility, and more.

Contributing

We welcome contributions! See our contributing guide for details on:

  • Reporting bugs
  • Suggesting enhancements
  • Submitting pull requests
  • Improving documentation

Local Development

npm install
npm run dev

OpenAPI schema

The REST API reference is generated from api-reference/openapi.json. Refresh it from the canonical API schema before validating or deploying docs:

npm run update:openapi
npm run check:openapi

CI also checks pull requests against the latest schema from https://api.fish.audio/openapi.json and opens an automatic update PR when the schema changes on main.

Commands

  • npm run dev - Start development server
  • npm run format - Format files
  • npm run format:check - Check formatting
  • npm run update:openapi - Pull the latest OpenAPI schema
  • npm run check:openapi - Validate the local OpenAPI schema
  • npm run validate - Refresh OpenAPI schema and validate the Mintlify docs

Community

Support