帮助文档
从快速开始到 API 参考，覆盖接入、计费与常见问题。控制台「帮助文档」入口同样打开这里。
入门指南
Agent 生图配置一次生图 Skill，之后只要告诉 AI“生图”或“编辑这张图”，它就能通过 Yomi API 完成图片创作。快速开始欢迎使用 Yomi API！本指南将带您完成注册、充值、创建密钥，并在几分钟内发起第一次模型调用。平台特色入门指南 平台特色 OpenAI 兼容接入 Yomi API 采用 OpenAI 兼容格式，一个接口即可调用全球主流大模型。已有项目只需替换 base_url 与密钥即可完成迁移；切换模型时修改 model 参数即可，无需为每家厂商单独适配 SDK。 支持的模型厂商 OpenAI： GPT-5.4、…价格说明入门指南 价格说明 定价原则 Yomi API 在保障服务质量的前提下提供有竞争力的价格： 海外模型价格同步： OpenAI、Claude 等海外模型，价格与官方一致。 国产模型更优惠： DeepSeek、GLM、Kimi 等国产模型，价格低于官方。 价格透明： 全部价格在模型广场公示，无隐形消费…异步生图接入入门指南 异步生图 先提交生图任务，取得任务 ID；再查询任务状态，成功后下载图片，也可通过 Webhook 接收完成通知。全程通过 API 操作，无需登录网站取图。所有接口以 https://api.yomiapi.com 为根地址，下面的路径已包含 /v1 ，不要重复拼接。 使用具有对应模型权限…
快速接入 Agent
Claude Code 命令行Claude Code 是运行在终端里的 AI 编程助手。设置几个环境变量，即可让它通过 Yomi API 调用 claude-sonnet-5 与 claude-opus-4-8。Codex 命令行Codex 是运行在终端里的 AI 编程代理。通过一份 config.toml 把服务商指向 Yomi API，即可用 gpt-5.6-sol、gpt-5.6-terra 等模型完成编码任务。DeepSeek HarnessDeepSeek Harness（命令 dsh）是 DeepSeek 于 2026 年 8 月 13 日发布的 AI 编程 agent，带 Web 界面、会话管理与工具调用能力。支持 OpenAI 兼容服务商，把配置指向 Yomi API 即可使用 deepseek-v4-pro 等模型。OpenClawOpenClaw 是开源的 AI 助手网关与机器人框架，支持 OpenAI 兼容接口。将其模型服务指向 Yomi API 后，即可使用平台目录中的全部对话模型。CC-SwitchCC-Switch 是 Claude Code、Codex、Gemini CLI 与 Grok Build 等多款 CLI 的服务商切换管理工具。将 Yomi API 添加为自定义服务商后，即可在不同服务商之间一键切换，无需每次手动修改环境变量或配置文件。WorkBuddyWorkBuddy 是桌面 AI 工作助手，支持自定义 API 接入。填入 Yomi API 的地址、密钥与模型 id，即可在 WorkBuddy 中使用平台的对话模型。VSCode + ClineCline 是 VS Code 中的 AI 编程代理扩展。把它的 API 提供商指向 Yomi API，即可在编辑器内用 claude-sonnet-5 等模型阅读与修改代码。Cherry StudioCherry Studio 是跨平台的 AI 桌面客户端，支持添加自定义模型提供商。将 Yomi API 添加为提供商后，即可在本地界面中调用平台目录里的各家模型。其他工具通用接入任何支持「OpenAI 兼容」或「自定义 API」的工具，只需 API 地址、API Key、模型 id 三项信息即可接入 Yomi API。
API 参考
API 概述与认证本篇给出调用 Yomi API 的基础约定：服务地址、认证方式、端点一览与通用错误码。各接口的详细参数与示例见对应分篇。图像理解（识图）识图能力通过 Chat Completions 的多模态消息实现：在消息中同时传入文本与图片，即可完成图像问答、OCR 文字识别与场景描述，无需调用独立端点。视频理解视频理解同样通过 Chat Completions 完成：在消息中传入视频内容部件，由多模态模型完成内容识别、场景描述与要点提取，平台没有独立的视频理解端点。对话补全Chat Completions 是平台最常用的接口，用于多轮对话与文本生成，与 OpenAI 接口格式完全兼容，可直接使用官方 SDK 调用。图像生成Images API 用于生成与编辑图像，接口与 OpenAI images 格式兼容。本篇聚焦通用调用方式，模型能力与效果对比详见媒体生成章节。嵌入向量与文本审核本篇覆盖两个接口:Embeddings 将文本转为语义向量，是语义搜索与 RAG 应用的基础;Moderations 检测文本中的违规内容，用于内容安全。模型列表与查询通过 Models 接口可以在程序中查询当前密钥可用的模型，用于动态展示模型选项或校验模型 id。模型选择建议按场景与预算挑选模型的速查建议。模型能力与实时价格以模型广场(控制台「模型服务」)为准。
媒体生成
Nano Banana 生成与编辑Nano Banana 是基于 Google Gemini 图像能力的生成与编辑模型系列（行业模型）。平台当前是否在售、具体模型 id 以模型广场（控制台「模型服务」）为准，下方示例仅展示调用格式。GPT Image 2.5 图像生成GPT Image 是 OpenAI 的图像生成与编辑模型系列，以精准的图内文字渲染见长，兼容 OpenAI Images 接口。当前具体在售型号与模型 id 以模型广场（控制台「模型服务」）为准。Veo 4 视频生成Veo 是视频生成模型系列，以长镜头一致性与物理真实感见长，支持文生视频与图生视频，通过异步任务接口调用。平台当前是否在售、具体模型 id 以模型广场（控制台「模型服务」）为准。
开发集成
SDK 集成Yomi API 完全兼容 OpenAI API 标准，直接使用 OpenAI 官方 SDK,只需修改 base_url 与 api_key 两项配置即可接入平台全部模型。OpenAI Responses APIResponses API 是 OpenAI 面向 Agent 场景的接口，在对话生成之上提供工具调用等 Agent 场景能力。Yomi API 支持 /v1/responses 与配套的上下文压缩接口。Claude 模型调用Yomi API 提供 Claude 系列模型，支持 OpenAI 兼容与 Anthropic 原生两种调用方式，可按现有技术栈自由选择。Gemini 原生格式Yomi API 提供 Gemini 原生 generateContent 调用格式（/v1beta 路由），供厂商原生 SDK 风格项目使用。当前在售模型以模型广场（控制台「模型服务」）为准，下方示例仅展示调用格式。模型切换Yomi API 的核心优势：一套代码，多种模型。用 OpenAI 格式跑通后，只需更换 model 参数即可切换到其他模型。
帮助支持
常见问题速查帮助支持 常见问题速查 如何切换模型？ 修改请求中的 model 参数即可，其他代码不变。例如将 deepseek-v4-flash 替换为 claude-sonnet-5 或 gpt-5.6-sol 。可用模型 id 见控制台「模型服务」（模型广场）。 支持哪些编程语言？ Yomi API 兼容 …账户与密钥帮助支持 账户与密钥 如何登录与管理账户？ 登录方式： 邮箱验证码一键登录（账号不存在时自动注册），或 GitHub 授权登录；无需设置密码。 账户信息： 用户名默认取邮箱，昵称可在设置中修改。 邀请奖励： 每个账户有唯一邀请码，新用户经您邀请注册后，您可获得额度奖励，详见用户中心「邀请收益」。 为…计费与并发帮助支持 计费与并发 密钥的计费模式有什么区别？ 计费口径： 文本模型按输入/输出 tokens 分别计费；媒体类模型是否支持按次计费，以模型广场（控制台「模型服务」）在售型号为准。 API 有并发限制吗？ 有。速率限制（Rate Limit）按模型与线路维度设置，不同模型拥有独立的并发池，单一模型…网络与安全帮助支持 网络与安全 使用 API 需要代理网络吗？ 不需要。Yomi API 提供全球直连服务，国内外均可直接访问。 国内访问 国内用户可以直接使用标准接入地址，无需额外配置 VPN 或代理。 海外访问 海外用户同样可以通过标准接入地址使用 Yomi API。 特殊网络环境 在个别受限网络（如严格…
知识库
大语言模型基础本文介绍大语言模型与 LLM API 的基础概念，帮助您在正式接入前建立必要的背景认知。模型系列介绍知识库 模型系列介绍 国际主流厂商 OpenAI(GPT 与 o 系列) OpenAI 的 GPT 系列奠定了「预训练 + 对话接口」的行业范式，从 GPT-3 确立提示词范式，到 GPT-4 一代普及多模态，再到当前的 GPT-5.x 一代。 gpt-5.6-sol 定位旗舰通用，擅长编程与多智能…技术概念知识库 技术概念 混合专家模型(MoE) 混合专家模型(Mixture of Experts,简称 MoE)是一种稀疏激活的神经网络架构：模型由多个「专家」子网络和一个门控网络(Router)组成，每次推理只激活其中少数专家，从而在扩大模型容量的同时控制计算成本，实现容量与算力的解耦。Mixtral…进阶指南知识库 进阶指南 长文本处理 当前主流模型的上下文窗口已相当可观，以平台在售型号为例: claude-sonnet-5 为 1M, gpt-5.6-sol 为 1.05M, kimi-k3 为 1M。即便如此，把超长文本整体塞入上下文仍会带来成本、延迟与中段信息被忽略的问题，常用策略: 分块处理(C…基础概念词汇知识库 基础概念词汇 文本与生成 Token(词元) 模型处理文本的最小单位。文本先被切分为 token,再转换为向量参与计算。英文中一个常见单词约为 1 个 token,中文一个汉字约为 1 到 2 个 token。token 同时是计费单位与上下文长度的衡量标准。 提示词(Prompt) 发送给…