Skip to content

fix(docs): correct Video API links across localized READMEs - #7116

Merged
Calcium-Ion merged 1 commit into
QuantumNous:mainfrom
To3akaRin:codex/fix-readme-video-api-links
Aug 31, 2026
Merged

fix(docs): correct Video API links across localized READMEs#7116
Calcium-Ion merged 1 commit into
QuantumNous:mainfrom
To3akaRin:codex/fix-readme-video-api-links

Conversation

@To3akaRin

@To3akaRin To3akaRin commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Agent

  • Tool: OpenAI Codex
  • Tool version: Codex desktop(运行时未暴露具体版本)
  • Model (full id): 运行时未暴露
  • Host (CLI / IDE / GitHub coding agent / other): IDE(Codex desktop)
  • Date (UTC): 2026-08-31

Links

User request

“修复 README 视频 API 链接,这个修复一下。”

Out of scope — refuse

  • Matched: no
  • If yes, what was told to the user (stop here; do not open a PR): not applicable

Kind

  • Bug fix
  • New feature
  • Performance / refactor
  • Docs
  • Other:

Issue facts

  • Actual behavior: 五份 README 的 Video 链接指向语音合成文档,README.en.md 的旧视频文档路径返回 404。
  • Impact: 用户点击视频接口文档时会进入错误的语音页面或 404 页面。
  • Frequency: 每次点击受影响链接都会发生。
  • Evidence that the problem is in new-api rather than the client or upstream: 错误 URL 直接存在于当前 main 的六份 README 中;对应 en、zh、ja 视频文档页面均可正常访问。
  • Applicable types and their fields (relay / billing / frontend / deployment; write "not applicable" otherwise): not applicable(仅文档链接)

Change

将六份 README 的 Video 链接更新为当前可用的 Sora 格式 Create Video 文档页,并保持各 README 原有语言前缀。未修改链接文案、代码、配置或其他文档链接。

Research

Duplicate / prior art

Docs and code

  • https://docs.newapi.ai/ : 当前官方文档域名会路由至 New API 文档站;实际链接验证使用 docs.newapi.pro,与 README 现有链接域名一致。
  • https://deepwiki.com/QuantumNous/new-api : 本次不涉及运行时行为,仅修复仓库 README 的静态链接。
  • README / repo docs: README.mdREADME.en.mdREADME.fr.mdREADME.ja.mdREADME.zh_CN.mdREADME.zh_TW.md
  • Code paths and what they imply for this change: not applicable;未修改代码路径。

Alternatives considered

  • Option A: 链接到 Videos 分类页。
  • Option B: 链接到已验证的 Sora Create Video 具体接口页。
  • Why this approach: 具体接口页当前返回 HTTP 200,并明确记录 POST /v1/videos,与 README 的“Video Interface”条目直接对应。

Files

Path Why
README.md 修复默认英文 README 的 Video 链接
README.en.md 替换返回 404 的旧视频文档路径
README.fr.md 修复法文 README 使用的英文 Video 文档链接
README.ja.md 修复日文 Video 文档链接
README.zh_CN.md 修复简体中文 Video 文档链接
README.zh_TW.md 修复繁体中文 Video 文档链接

Behavior

  • Before: Video 链接进入 Text-to-Speech 页面或返回 404。
  • After: en、zh、ja 链接进入对应语言的 Create Video 页面,并显示 POST /v1/videos
  • Explicit non-goals / leftover work: 不清理其他 README 失效链接,不修改文案或文档结构。

Verification

  • Commands and results: git diff --check 通过;最终差异为 6 files changed, 6 insertions(+), 6 deletions(-)。
  • Manual steps and observed result: 对 en、zh、ja 三个目标 URL 执行 HTTP 请求,均返回 200,页面内容均包含 /v1/videos
  • UI: 无;仅静态 Markdown 链接修改。
  • Tests added or updated, or why none: 未新增自动化测试;该改动不涉及可执行代码,使用链接可用性与差异范围检查验证。
  • Databases / providers / platforms exercised: not applicable。
  • Not verified: PR 创建后的 GitHub Actions CI 状态。

Risks

  • Failure modes: 官方文档未来再次调整路由时链接可能失效。
  • Billing / quota / auth impact: none。
  • Follow-ups: 可另行检查 README 中其他历史文档链接;不纳入本 PR。

Scope check

  • Single focused change: yes
  • Secrets included: no
  • Out of scope (Coding Plan / reverse-engineered channel / third-party wrapper / Codex): no

本次修改与 PR 描述由 OpenAI Codex 辅助生成。

Summary by CodeRabbit

  • Documentation
    • Corrected the Video interface links in all localized README files.
    • Links now direct readers to the Sora video-generation API documentation instead of audio speech-synthesis documentation.

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 858e046b-47cb-4acc-b668-77a6232d7b60

📥 Commits

Reviewing files that changed from the base of the PR and between 27ff6a8 and 2d5c11c.

📒 Files selected for processing (6)
  • README.en.md
  • README.fr.md
  • README.ja.md
  • README.md
  • README.zh_CN.md
  • README.zh_TW.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


Walkthrough

The supported interfaces lists now link the Video Interface entries in six localized README files to the Sora video-generation documentation.

Changes

Localized README links

Layer / File(s) Summary
Correct Video Interface URLs
README.md, README.en.md, README.fr.md, README.ja.md, README.zh_CN.md, README.zh_TW.md
Replaced incorrect audio speech documentation links with localized Sora video-generation documentation links.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 2d5c1

The PR updates six README Video API links to the verified Sora Create Video documentation pages without changing code or runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: calcium-ion

Poem

A rabbit checks each guide,
Six links hop to Sora's side,
Audio paths retreat,
Video docs are neat,
Clear trails for paws and feet.

🚥 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 clearly summarizes the primary change: correcting Video API links across localized README files.
Linked Issues check ✅ Passed The pull request addresses issue #3186 by replacing incorrect audio or outdated Video Interface links with locale-specific Sora video documentation links in the affected README files. The additional E…
Out of Scope Changes check ✅ Passed All changes are limited to correcting Video Interface documentation links in README files. No unrelated code, configuration, documentation links, or README structure changes are included.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

The pull request addresses issue #3186 by replacing incorrect audio or outdated Video Interface links with locale-specific Sora video documentation links in the affected README files. The additional English README update is directly related to the same objective.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (6 skipped: 6 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@Calcium-Ion
Calcium-Ion merged commit 67a0585 into QuantumNous:main Aug 31, 2026
1 check passed
yiranxiaohui pushed a commit to yiranxiaohui/new-api that referenced this pull request Sep 2, 2026
kiminbaek pushed a commit to kiminbaek/new-api that referenced this pull request Sep 5, 2026
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.

fix(docs): Fix incorrect Video Interface URL in all language READMEs

2 participants