Skip to content

docs: add voice design API documentation#85

Merged
Kilerd merged 2 commits into
mainfrom
codex/voice-design-docs
Jun 16, 2026
Merged

docs: add voice design API documentation#85
Kilerd merged 2 commits into
mainfrom
codex/voice-design-docs

Conversation

@Kilerd

@Kilerd Kilerd commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • refresh the canonical OpenAPI schema so POST /v1/voice-design appears in the generated API contract
  • add Voice Design API reference and overview docs with request fields, response handling, billing notes, and examples
  • link Voice Design from navigation, API introduction, pricing, llms.txt, and the raw API skill

Validation

  • npm run update:openapi
  • npm run check:openapi
  • ./node_modules/.bin/prettier --check api-reference/endpoint/openapi-v1/voice-design.mdx features/voice-design.mdx
  • git diff --check

Notes

  • ./node_modules/.bin/mint validate is not available in the installed Mint CLI.
  • ./node_modules/.bin/mint broken-links still reports existing broken links in .mintlify/skills/fish-audio-sdk and temp/; it does not report the new Voice Design docs.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced Voice Design API endpoint for generating candidate voices from text prompts and optional reference audio.
  • Documentation

    • Added comprehensive Voice Design feature documentation including API reference, pricing ($0.01 per successful request), quick-start guides, and code examples in multiple languages.
    • Updated platform navigation and documentation index to include Voice Design resources.

@mintlify

mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hanabiaiinc 🟢 Ready View Preview Jun 16, 2026, 7:53 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Adds end-to-end documentation for a new POST /v1/voice-design endpoint: an OpenAPI spec with VoiceDesignRequest and VoiceDesignCandidate schemas, a feature guide page, an API reference MDX page, pricing details (voice-design-1 at $0.01/request), navigation entries in docs.json, llms.txt index links, and an updated AI skill file.

Changes

Voice Design API Documentation

Layer / File(s) Summary
OpenAPI schema and endpoint definition
api-reference/openapi.json
Adds POST /v1/voice-design path with required model: voice-design-1 header, VoiceDesignRequest body schema (required instruction, optional reference_text, language, seed, and numeric generation parameters), and VoiceDesignCandidate response schema (audio_base64, sample_rate, duration_ms, plus optional fields). Standard 401/402/422 error responses and an x-codeSamples entry are also included.
Feature guide and API reference MDX docs
features/voice-design.mdx, api-reference/endpoint/openapi-v1/voice-design.mdx, api-reference/introduction.mdx
Adds the complete features/voice-design.mdx page covering overview cards, use-case guidance, curl/Python/JavaScript quick-start examples, full request field reference, response schema with candidates JSON sample, and billing/error notes. Adds the api-reference/endpoint/openapi-v1/voice-design.mdx endpoint doc page with request constraints, base64 audio response notes, and a curl example. Inserts a "Design a Voice" subsection into the API introduction.
Pricing, navigation, and discovery wiring
developer-guide/models-pricing/pricing-and-rate-limits.mdx, docs.json, llms.txt, .mintlify/skills/fish-audio-api/SKILL.md
Inserts Voice Design pricing table (voice-design-1 at $0.01 per successful request) and billing exclusion rules. Extends docs.json with a Core Features page entry and a REST API navigation group for Voice Design. Adds llms.txt links under "Core REST API" and "Product Guides." Updates the SKILL.md description, endpoint map, and adds a full Voice Design section with headers, field constraints, forbidden content rules, curl/Python examples, and a billing note.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • fishaudio/docs#70: Originally introduced the .mintlify/skills/fish-audio-api/SKILL.md AI agent skill file that this PR extends with the new POST /v1/voice-design endpoint block.

Suggested reviewers

  • twangodev

Poem

🐇 A voice from a prompt, designed in a flash,
Base64 audio decoded in a dash.
The spec is now whole, the docs are in place,
New endpoints and schemas added with grace.
Hop on, dear dev — your voice, your design! 🎙️

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding Voice Design API documentation across multiple files and sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/voice-design-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Kilerd Kilerd marked this pull request as ready for review June 16, 2026 08:11
@Kilerd Kilerd changed the title [codex] add voice design API documentation docs: add voice design API documentation Jun 16, 2026
@Kilerd Kilerd merged commit ea2caf8 into main Jun 16, 2026
5 of 6 checks passed
@Kilerd Kilerd deleted the codex/voice-design-docs branch June 16, 2026 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant