# DeerAPI-API文档

## Docs

- [文生音效](https://apidoc.deerapi.com/api/audio/kling/text-to-audio.md): DeerAPI 文生音效接入说明：聚焦 text-to-audio 的最小参数、任务查询和 callback 用法。
- [语音合成](https://apidoc.deerapi.com/api/audio/kling/tts.md): DeerAPI Kling TTS 接入说明：聚焦 voice_id、voice_language、voice_speed 的最小组合和常见错误排查。
- [视频生音效](https://apidoc.deerapi.com/api/audio/kling/video-to-audio.md): DeerAPI 视频生音效接入说明：说明 video-to-audio 的视频来源、查询方式和 callback 用法。
- [音频转文本](https://apidoc.deerapi.com/api/audio/openai/stt.md): DeerAPI 音频转文本接口文档：通过 POST /v1/audio/transcriptions 将音频转录为输入语言，提供统一的 OpenAI 兼容调用方式。
- [创建翻译](https://apidoc.deerapi.com/api/audio/openai/translation.md): DeerAPI 创建翻译接口文档：通过 POST /v1/audio/translations 按参数请求音频翻译，统一调用 OpenAI 等模型的音频翻译 API。
- [文本转音频](https://apidoc.deerapi.com/api/audio/openai/tts.md): DeerAPI 文本转音频 API（POST /v1/audio/speech）支持选择 tts-1 模型与 voice 声线，将 input 文本快速转换为语音输出。
- [SeedEdit 图像编辑](https://apidoc.deerapi.com/api/image/doubao/seededit.md): DeerAPI Seededit 图像编辑接口文档：通过 POST /v1/images/edits 调用 doubao-seededit-3-0-i2i-250628 完成单图编辑，适合第一次接入 DeerAPI 时快速完成本地图上传和编辑生成。
- [Seedream 生图](https://apidoc.deerapi.com/api/image/doubao/seedream.md): DeerAPI Seedream 图像生成接口文档：通过 POST /v1/images/generations 调用豆包 Seedream 4.0、4.5、5.0 进行文生图、图生图和组图生成，适合第一次接入 DeerAPI 的用户快速开始。
- [创建任务](https://apidoc.deerapi.com/api/image/flux/create-task-replicate.md): DeerAPI FLUX 专用 Replicate 风格创建任务接口：通过 POST /replicate/v1/models/{models}/predictions 使用完整的 black-forest-labs 模型 ID 创建图片任务，适合已有 Replicate 风格代码或需要标准 Predictions 对象的场景。
- [生成图片](https://apidoc.deerapi.com/api/image/flux/generate.md): DeerAPI FLUX 生成图片接口：通过 POST /flux/v1/{model} 统一调用 BFL 风格异步生图与编辑能力，支持 FLUX 1.1、FLUX 2、Kontext、Expand、Fill 等当前已接入的 DeerAPI 短模型 ID，并可用 /flux/v1/get_result 查询结果。
- [兼容旧版生图](https://apidoc.deerapi.com/api/image/flux/legacy-predictions.md): DeerAPI 旧版 Replicate 兼容生图接口文档：通过 POST /replicate/v1/predictions 兼容官方 Predictions.create 语义，适合已有旧代码迁移；新项目不建议优先从这里开始。
- [任务查询](https://apidoc.deerapi.com/api/image/flux/query-task.md): DeerAPI 统一查询任务接口：通过 GET /flux/v1/get_result 查询 FLUX 短路径任务，也兼容 Replicate 风格任务 ID，适合希望用一条查询链路覆盖 BFL 与 Replicate 风格创建方式的场景。
- [图像生成](https://apidoc.deerapi.com/api/image/gemini/generate-image.md): DeerAPI Gemini 生图接口文档：通过统一接口调用 Gemini 3.1 Flash Image、Gemini 3 Pro Image、Gemini 2.5 Flash Image 进行图像生成与编辑，支持 4K 分辨率、Google Search 增强、多图参考等高级功能。
- [Gemini Pro 生图指南](https://apidoc.deerapi.com/api/image/gemini/pro-image-guide.md): DeerAPI 调用 Gemini 图像生成模型完整指南：文生图、图生图、多图生图的详细使用方法，包含 Python/Node.js/curl 示例与 Base64 图片解析。
- [扩图](https://apidoc.deerapi.com/api/image/kling/expand.md): DeerAPI 扩图接入说明：说明 Kling image expansion 的扩边参数、查询方式与 callback 使用方式。
- [图像生成](https://apidoc.deerapi.com/api/image/kling/generate.md): DeerAPI 图像生成接入说明：统一说明 Kling image generation 的 capability ID、model_name、查询方式与回调用法。
- [多图参考生图](https://apidoc.deerapi.com/api/image/kling/generate-with-references.md): DeerAPI 多图参考生图接入说明：说明当前能力页与官方 multiImageToImage 的对应关系、model_name 与查询回调方式。
- [图像识别](https://apidoc.deerapi.com/api/image/kling/recognize.md): DeerAPI 图像识别接入说明：聚焦 Kling image-recognize 的输入要求、同步结果结构与 capability ID。
- [虚拟试穿](https://apidoc.deerapi.com/api/image/kling/virtual-try-on.md): DeerAPI 虚拟试穿接入说明：说明 Kolors try-on 的 capability ID、model_name、服饰输入约束和查询方式。
- [快速入门](https://apidoc.deerapi.com/api/image/midjourney/quick-start.md): DeerAPI Midjourney API 快速入门：理解模拟 Discord 按钮交互的状态机机制，掌握 imagine 提交、task 查询轮询、action 点击与 modal 额外输入的完整调用流程。
- [提交 Action 任务](https://apidoc.deerapi.com/api/image/midjourney/submit-action.md): DeerAPI 提交Action任务接口：通过 POST /mj/submit/action 对 imaging api 生成图像执行 UPSCALE、VARIATION、REROLL、ZOOM 等操作，快速完成 Midjourney Action 任务调用。
- [提交 Blend 任务](https://apidoc.deerapi.com/api/image/midjourney/submit-blend.md): DeerAPI 提交Blend任务接口：通过 POST /mj/submit/blend 调用 Midjourney，上传一个或多个图像融合生成新图像，适合大陆用户统一接入。
- [提交 Describe 任务](https://apidoc.deerapi.com/api/image/midjourney/submit-describe.md): DeerAPI 提交Describe任务接口文档：通过 POST /mj/submit/describe 调用 Midjourney API，从上传图像中检测并生成初始提示词，适用于图片转提示词场景。
- [提交编辑任务](https://apidoc.deerapi.com/api/image/midjourney/submit-edit.md): DeerAPI 提交编辑任务接口：通过 POST /mj/submit/edits 调用 Midjourney API，支持图片编辑（maskBase64+prompt，可选原图）与转绘（image+prompt）。
- [提交 Imagine 任务](https://apidoc.deerapi.com/api/image/midjourney/submit-imagine.md): DeerAPI 提交Imagine任务接口文档：通过 UniAgi Midjourney API 调用 POST /mj/submit/imagine 创建图像生成任务，返回 task_id 并可查询进度，支持图片转视频参数 --motion/--video 及循环、结束图。
- [提交 Modal 任务](https://apidoc.deerapi.com/api/image/midjourney/submit-modal.md): DeerAPI 提交Modal接口（POST /mj/submit/modal），用于提交Midjourney缩放或区域重绘生成的模态，继续下一步图像编辑流程。
- [提交视频任务](https://apidoc.deerapi.com/api/image/midjourney/submit-video.md): DeerAPI 提交视频任务接口文档：通过 POST /mj/submit/video 统一调用 Midjourney，实现视频生成任务提交与参数配置，适用于大陆用户快速接入。
- [按 ID 查询](https://apidoc.deerapi.com/api/image/midjourney/tasks/get.md): DeerAPI 指定ID获取任务：通过 GET /mj/task/{id}/fetch 快速稳定查询 Midjourney 单个任务状态与结果，适合中途任务追踪与排查。
- [分页查询](https://apidoc.deerapi.com/api/image/midjourney/tasks/list.md): DeerAPI 分页查询：通过 POST /mj/task/list-by-condition 分页获取一个或多个 Midjourney 中途任务状态，便于批量检索与管理任务列表。
- [图像编辑](https://apidoc.deerapi.com/api/image/openai/edit.md): DeerAPI 图像编辑(gpt-image-1)接口文档：POST /v1/images/edits 调用说明，参数因模型而异，支持参考 OpenAI Create image edit 与 Qwen Image Edit API，qwen-image-edit 无需 n 且仅输出一张。
- [图像生成](https://apidoc.deerapi.com/api/image/openai/generate.md): DeerAPI OpenAI 图像 API：通过 /v1/images/generations 文本提示词生成高质量图片，支持多尺寸、URL/base64 输出、批量生成与风格控制，并说明内容政策与返回格式。
- [创建任务](https://apidoc.deerapi.com/api/image/replicate/create-task.md): DeerAPI 通用 Replicate 风格创建任务接口：通过 POST /replicate/v1/models/{models}/predictions 调用当前已接入的 Replicate 风格图片模型，适合已有 Replicate 工作流、需要标准 Predictions 对象、或希望使用完整模型 ID 路径的用户。
- [任务查询](https://apidoc.deerapi.com/api/image/replicate/query-task.md): DeerAPI Replicate 风格任务查询接口文档：通过 GET /replicate/v1/predictions/{id} 获取标准 Predictions 对象，适合已有 Replicate 工作流或依赖固定状态字段的场景。
- [拓展 style tags](https://apidoc.deerapi.com/api/music/suno/expand-style-tags.md): DeerAPI Suno 拓展 style tags 接口（POST /suno/act/tags），将简单关键词扩展为专业音乐风格描述，补全乐器、编曲与制作细节，提升音乐生成效果。
- [全轨声曲分离](https://apidoc.deerapi.com/api/music/suno/full-track-separate.md): DeerAPI 全轨声曲分离接口指南：通过 POST /suno/submit/music 提交 task_id 与 clip_id 获取分轨任务，查询返回各轨 clip_id 与 URL，并说明 Suno 参数与 5 倍计费规则。
- [生成歌词](https://apidoc.deerapi.com/api/music/suno/generate-lyrics.md): DeerAPI 提供 Suno 生成歌词 API：通过 POST /suno/submit/lyrics 按主题生成 AI 歌词，返回 task_id 可单任务查询状态，并支持与生成音乐片段接口联动。
- [生成音乐](https://apidoc.deerapi.com/api/music/suno/generate-music.md): DeerAPI 生成音乐接口文档：POST /suno/submit/music 支持 Suno 六种模式（灵感、自定义、续写、人设、配音、填词）提交生成请求，并通过 task_id 查询任务状态与结果。
- [生成 mp4 mv 视频](https://apidoc.deerapi.com/api/music/suno/generate-mv.md): DeerAPI 生成 mp4 mv 视频接口：通过 GET /suno/act/mp4/{clip_id} 获取已完成音乐片段的 MP4 视频 URL，支持下载分享，URL 通常有效 2-3 天。
- [获取 midi](https://apidoc.deerapi.com/api/music/suno/get-midi.md): DeerAPI 获取 midi 接口文档：通过 GET /suno/act/midi/{clip_id} 为 Suno 音乐片段创建音频转 MIDI 任务，返回 task_id 并轮询查询获取下载 URL，支持普通与全轨 clip_id。
- [获取 vox](https://apidoc.deerapi.com/api/music/suno/get-vox.md): DeerAPI 获取 vox 接口文档：通过 POST /suno/act/vox/{clip_id} 调用 Suno 获取指定 clip_id 的 vox 数据，说明必填参数与 Content-Type，便于音乐生成集成。
- [获取 wav 格式文件](https://apidoc.deerapi.com/api/music/suno/get-wav.md): DeerAPI 提供 Suno 获取 wav 格式文件接口文档，支持通过 GET /suno/act/wav/{clip_id} 拉取已完成音乐片段的无损 WAV 下载 URL，并说明任务需 complete 及 URL 2-3 天有效期。
- [Timing:歌词、音频时间线](https://apidoc.deerapi.com/api/music/suno/lyrics-timeline.md): DeerAPI 提供 Suno Timing:歌词、音频时间线接口（GET /suno/act/timing/{clip_id}），获取与音频同步的词级歌词时间与置信度，适用于卡拉OK、字幕与歌词视频生成。
- [新建 Persona](https://apidoc.deerapi.com/api/music/suno/new-persona.md): DeerAPI Suno 新建 Persona 接口文档：通过生成音乐获取 task id 与 clip_id，调用 POST /suno/persona/create 创建 persona_id，用于后续一致性歌手风格创作。
- [批量查询任务](https://apidoc.deerapi.com/api/music/suno/query-batch.md): DeerAPI 批量查询任务接口（POST /suno/fetch）支持一次查询多个 Suno 音乐生成等异步任务状态与结果，减少 API 调用次数并提升监控与检索效率。
- [查询单个任务](https://apidoc.deerapi.com/api/music/suno/query-single.md): DeerAPI 查询单个任务接口：通过 GET /suno/fetch/{task_id} 轮询获取 Suno 音乐/歌词生成等异步任务状态与结果，返回音频URL、clip_id、元数据。
- [设置 suno 版本](https://apidoc.deerapi.com/api/music/suno/set-version.md): DeerAPI 设置 suno 版本指南：在提交音乐生成任务时通过 mv 参数选择 Suno v3.0-v5（如 chirp-bluejay、chirp-crow），并提供完整版本对照表。
- [单轨声曲分离](https://apidoc.deerapi.com/api/music/suno/single-track-separate.md): DeerAPI 单轨声曲分离文档：通过 POST /suno/submit/music 提交 task_id 与 clip_id 生成分轨任务，查询返回各轨 clip_id 与 url，适用于 Suno 分轨处理。
- [歌曲拼接](https://apidoc.deerapi.com/api/music/suno/song-concat.md): DeerAPI 歌曲拼接接口：通过 POST /suno/submit/concat 将 extend 续写生成的音乐片段 clip_id 无缝合并为完整音轨，并配合单任务查询获取拼接结果。
- [Suno API 场景应用指南](https://apidoc.deerapi.com/api/music/suno/suno-api-guide.md): DeerAPI Suno API 场景应用指南，详解提交/获取接口与 v4.5-v5.5 mv 参数，覆盖灵感生成、歌词歌名自定义、纯音乐与续写扩展等调用示例。
- [上传音乐](https://apidoc.deerapi.com/api/music/suno/upload-music.md): DeerAPI 上传音乐接口文档：通过 POST /suno/uploads/audio-url 从 URL 上传音频片段，获取任务 ID，用于继续生成音乐或合并片段。
- [Claude 消息](https://apidoc.deerapi.com/api/text/anthropic/messages.md): DeerAPI Anthropic Claude Messages 接口文档：通过 POST /v1/messages 发送文本/图像结构化消息列表，支持单轮与无状态多轮对话，包含 Extended Thinking、Prompt Caching、Web Search 与流式等用法提示。
- [文本对话](https://apidoc.deerapi.com/api/text/gemini/generate-content.md): DeerAPI Gemini 文本对话文档：通过统一 Base URL 与 API Key 兼容 Gemini 原生接口，支持 generateContent、Thinking、流式响应、Google Search、系统指令等功能。
- [对话补全](https://apidoc.deerapi.com/api/text/openai/chat.md): DeerAPI Chat Completions 文档：统一调用 OpenAI 等模型的 /v1/chat/completions 接口，基于 messages 对话列表生成回复，支持 stream 流式输出、reasoning_effort 推理控制、web_search_options 网页搜索等参数，并说明响应透传与模型差异。
- [向量嵌入](https://apidoc.deerapi.com/api/text/openai/embeddings.md): DeerAPI Embeddings 接口文档：通过 POST /v1/embeddings 使用 OpenAI 模型为输入文本生成 embedding 向量，说明必填参数 model 与 input。
- [模型列表](https://apidoc.deerapi.com/api/text/openai/models.md): DeerAPI 获取模型列表接口文档：通过 GET /v1/models 检索所有可用 OpenAI 模型信息，提供统一 API Endpoint https://api.deerapi.com/v1/models。
- [响应接口](https://apidoc.deerapi.com/api/text/openai/responses.md): DeerAPI OpenAI Responses 接口（POST /v1/responses）文档：支持文本/图像多模态输入、函数调用与工具集成，实现有状态对话与高质量文本输出。
- [Kling 数字人创建任务](https://apidoc.deerapi.com/api/video/kling/avatar-create.md): DeerAPI Kling 数字人接入说明：聚焦头像图、音频来源、异步查询路径和 callback 的最佳实践。
- [回调协议](https://apidoc.deerapi.com/api/video/kling/callback.md): DeerAPI Kling Callback 协议：为异步图像、视频、音频与虚拟试穿任务配置 callback_url 后，平台会在任务状态变化时主动推送结果。
- [视频延长](https://apidoc.deerapi.com/api/video/kling/extend-video.md): DeerAPI 视频延长接入说明：说明 Kling video-extend 的父视频依赖、最小入参，以及查询和回调的推荐接法。
- [图生视频](https://apidoc.deerapi.com/api/video/kling/image-to-video.md): DeerAPI 图生视频接入说明：通过统一网关调用 Kling image2video，说明首帧、尾帧、model_name 与查询回调的关系。
- [对口型创建](https://apidoc.deerapi.com/api/video/kling/lipsync-create.md): DeerAPI 对口型创建任务接入说明：聚焦 advanced-lip-sync 的两步流程、session_id 复用以及查询回调方式。
- [对口型识别](https://apidoc.deerapi.com/api/video/kling/lipsync-face.md): DeerAPI 对口型人脸识别接入说明：说明 identify-face 的输入要求、session_id 有效期，以及后续 advanced lip sync 任务流。
- [多图参考生视频](https://apidoc.deerapi.com/api/video/kling/multi-image-to-video.md): DeerAPI 多图参考生视频接入说明：聚焦 Kling multi-image2video 的多图输入、固定 model_name、查询与回调流程。
- [增加视频选区](https://apidoc.deerapi.com/api/video/kling/multimodal-edit/add-mask.md): DeerAPI Kling 多元素编辑打点页：在指定帧用坐标点告诉系统你要跟踪哪个主体，再把点选结果扩成选区。
- [清除视频选区](https://apidoc.deerapi.com/api/video/kling/multimodal-edit/clear-mask.md): DeerAPI Kling 多元素编辑清空页：当当前 session 的选区整体不可用时，用 clear-selection 把选区全部清掉后重新开始。
- [创建任务](https://apidoc.deerapi.com/api/video/kling/multimodal-edit/create-task.md): DeerAPI Kling 多元素编辑最终提交页：在 session 已准备好之后，用 POST /kling/v1/videos/multi-elements 真正发起编辑任务。
- [初始化待编辑视频](https://apidoc.deerapi.com/api/video/kling/multimodal-edit/init-video.md): DeerAPI Kling 多元素编辑初始化页：先为待编辑视频创建 `session_id`，后面的加选区、预览和最终编辑都围绕它展开。
- [预览已选区视频](https://apidoc.deerapi.com/api/video/kling/multimodal-edit/preview-mask.md): DeerAPI Kling 多元素编辑预览页：在真正发起编辑前，用 `preview-selection` 先确认选区跟踪范围是否正确。
- [删减视频选区](https://apidoc.deerapi.com/api/video/kling/multimodal-edit/remove-mask.md): DeerAPI Kling 多元素编辑删减页：当当前 session 的选区过大、跟错主体或局部污染背景时，用 delete-selection 做减法修正。
- [Omni 查询](https://apidoc.deerapi.com/api/video/kling/omni-query.md): DeerAPI Omni 查询说明：用于轮询 Kling Omni Video 任务状态与结果，适合和 Omni Video 创建接口配套使用。
- [Omni 视频](https://apidoc.deerapi.com/api/video/kling/omni-video.md): DeerAPI Omni Video 接入说明：说明 capability ID、官方 model_name、素材引用语法，以及专用查询页的使用方式。
- [任务查询](https://apidoc.deerapi.com/api/video/kling/query-task.md): DeerAPI Kling 通用查询入口：通过 GET /kling/v1/{action}/{action2}/{task_id} 复用常见异步任务的单任务查询逻辑。
- [文生视频](https://apidoc.deerapi.com/api/video/kling/text-to-video.md): DeerAPI 文生视频接入说明：通过统一网关调用 Kling text2video，明确区分 DeerAPI capability ID 与请求体 model_name，并说明查询与回调方式。
- [视频特效](https://apidoc.deerapi.com/api/video/kling/video-effects.md): DeerAPI Kling 视频特效指南：用模板特效而不是自由生成的方式快速接入 `effects`，并明确 effect_scene、input、查询与回调的配合。
- [创建视频](https://apidoc.deerapi.com/api/video/sora-2/official/create-video.md): DeerAPI Sora 官方格式创建接口文档：通过 POST /v1/videos 使用 `sora-2` 或 `sora-2-pro` 创建标准 Videos API 任务，适合第一次接 DeerAPI 时直接按官方工作流接入。
- [下载视频](https://apidoc.deerapi.com/api/video/sora-2/official/download-video.md): DeerAPI Sora 官方格式下载接口：通过 GET /v1/videos/{video_id}/content 下载已完成任务的 MP4，也支持通过 `variant` 获取缩略图或 spritesheet。
- [混编视频](https://apidoc.deerapi.com/api/video/sora-2/official/remix-video.md): DeerAPI Sora 官方格式混编接口文档：通过 POST /v1/videos/{video_id}/remix 对已完成的 `sora-2` 或 `sora-2-pro` 任务做小范围定向修改。
- [检索视频](https://apidoc.deerapi.com/api/video/sora-2/official/search-video.md): DeerAPI Sora 官方格式检索接口文档：通过 GET /v1/videos/{video_id} 轮询 `sora-2` 与 `sora-2-pro` 任务状态，获取进度、终态和下载过期时间。
- [异步创建](https://apidoc.deerapi.com/api/video/veo3/async/create.md): DeerAPI veo3 异步 Wrapper 视频生成接口文档：通过 POST /v1/videos 创建 veo3 系列任务并返回 video_id，适合第一次接 DeerAPI 时使用明确的异步创建与轮询工作流。
- [异步查询](https://apidoc.deerapi.com/api/video/veo3/async/query.md): DeerAPI veo3 异步 Wrapper 查询接口：通过 GET /v1/videos/{video_id} 轮询 veo3 异步 Wrapper 任务状态，适合第一次接入 DeerAPI 时实现标准的创建后查询流程。
- [Veo 3 Chat](https://apidoc.deerapi.com/api/video/veo3/chat.md): DeerAPI veo3 chat 兼容格式文档：通过 POST /v1/chat/completions 以 OpenAI Chat Completions 风格调用 veo3 系列视频生成，适合复用已有 OpenAI SDK 或 chat 客户端。
- [常见误区](https://apidoc.deerapi.com/help/common-mistakes.md): DeerAPI 常见误区汇总：余额与 API Key 额度区别、Base URL 设置导致 Key 无效或无响应、RPM/TPM 并发限制说明，以及新建 API Key 与图片 base64 分析调用指引。
- [错误码与排障](https://apidoc.deerapi.com/help/error-codes.md): DeerAPI 错误码排障指南：基于线上实测校准 400、401 与 Base URL 路径错误，并给出 403、429、500、503 的保守处理建议。
- [使用困惑](https://apidoc.deerapi.com/help/faq.md): DeerAPI 常见问题：文生图/文生视频选型、推理模型支持、Embedding、错误码排查、工具接入与 API Key 配置。
- [帮助中心](https://apidoc.deerapi.com/help/overview.md): DeerAPI 帮助中心：介绍大模型API聚合平台的计费倍率、调价公告、并发与维护机制、隐私声明及充值折扣/到账与异常扣费处理，兼容 OpenAI 接口协议。
- [隐私政策](https://apidoc.deerapi.com/help/privacy.md): DeerAPI 隐私与数据保护政策：承诺不收集或保存与 AI 大模型的对话内容，说明自动收集信息、第三方登录、Cookie 使用、信息安全与共享规则。
- [接口稳定性](https://apidoc.deerapi.com/help/stability.md): DeerAPI 接口稳定性与性能说明：详解 RPM、TPM、IPM 等限额参数含义，并给出 TPM 5000 万、RPM 3 万的理论性能，支持高并发 API 调用挑战极限。
- [服务条款](https://apidoc.deerapi.com/help/terms.md): DeerAPI 服务条款说明大模型 API 聚合平台的服务内容、账户安全、API 调用规则、隐私与费用结算、合规要求、禁止行为及条款变更与联系方式。
- [AnythingLLM](https://apidoc.deerapi.com/integration/anythingllm.md): DeerAPI AnythingLLM 集成指南：获取 DeerAPI API Key 与 baseurl，在 AnythingLLM 选择 Generic OpenAI 填入 https://api.deerapi.com/v1 完成 API 配置并测试调用。
- [avante.nvim](https://apidoc.deerapi.com/integration/avante-nvim.md): DeerAPI avante.nvim 集成指南：登录获取 DeerAPI API Key 与 baseurl，并在配置文件中将 API 地址设为 https://api.deerapi.com/v1，完成 avante.nvim OpenAI 接口配置。
- [余额查询](https://apidoc.deerapi.com/integration/best-practices/balance-api.md): DeerAPI 账户余额查询 API：通过 GET 请求获取余额、消耗额度、请求次数及各 Key 剩余额度。
- [Midjourney 最佳实践](https://apidoc.deerapi.com/integration/best-practices/midjourney-best-practices.md): DeerAPI Midjourney API 最佳实践：Imagine 绘图、Action 动作、Change 变体、Modal 局部重绘和任务查询接口的参数与响应说明。
- [重试逻辑](https://apidoc.deerapi.com/integration/best-practices/retry-logic.md): DeerAPI 重试逻辑：优先通过 DeerAPI 调用，遇到 HTTP 错误自动切换到 OpenAI 官方 API 重试，含 Python 完整示例。
- [Runway 最佳实践](https://apidoc.deerapi.com/integration/best-practices/runway-best-practices.md): DeerAPI Runway 视频生成 API 最佳实践：任务提交重试逻辑（code=200 判断成功）、Webhook 回调配置，以及回调字段说明。
- [ChatAll](https://apidoc.deerapi.com/integration/chatall.md): DeerAPI ChatAll 集成指南：下载 ChatAll 后获取 API Key，按 OpenAI 配置将 baseurl 设为 https://api.deerapi.com/v1 并填入 DeerAPI API Key，即可在 ChatAll 中切换模型对话。
- [Chatbox](https://apidoc.deerapi.com/integration/chatbox.md): DeerAPI Chatbox 集成指南：下载并登录获取 API Key，在 Chatbox 选择 OpenAI API，配置 baseurl https://api.deerapi.com 与 API Key完成调用测试，并可新增自定义模型 ID。
- [ChatHub](https://apidoc.deerapi.com/integration/chathub.md): DeerAPI ChatHub 集成指南：下载 ChatHub 后获取 DeerAPI API Key 与 baseurl，在 OpenAI 配置中填写 API host 与 API Key，完成调用测试快速接入。
- [CherryStudio](https://apidoc.deerapi.com/integration/cherrystudio.md): DeerAPI CherryStudio 集成指南：获取 DeerAPI API Key 并在 CherryStudio 选择 OpenAI 提供商，配置 baseurl https://api.deerapi.com，添加当前模型 ID 并完成调用测试。
- [Claude Code](https://apidoc.deerapi.com/integration/claude-code.md): 通过 DeerAPI 使用 Claude Code：安装官方客户端，配置 ANTHROPIC_AUTH_TOKEN 和 ANTHROPIC_BASE_URL，在终端中调用 Claude 编程助手。
- [Cline](https://apidoc.deerapi.com/integration/cline.md): DeerAPI Cline 集成指南：在 VS Code 安装插件，获取 API Key 并配置 OpenAI compatible 的 Base URL（https://api.deerapi.com/v1），完成 API 调用测试。
- [Codex CLI](https://apidoc.deerapi.com/integration/codex.md): 通过 DeerAPI 使用 OpenAI Codex CLI：安装 Codex、配置 config.toml 自定义 Provider、写入 auth.json API Key，即可在终端中调用 AI 编程代理。
- [Coze](https://apidoc.deerapi.com/integration/coze.md): DeerAPI COZE 集成指南：教你在 Coze 创建 Agent，通过插件或 HTTP Request 配置 DeerAPI 的 API Key 与 chat/completions 接口，快速调用当前模型。
- [Cursor](https://apidoc.deerapi.com/integration/cursor.md): DeerAPI Cursor 集成指南：获取 API Key 并在 Cursor 中配置 https://api.deerapi.com/v1 完成验证与调用测试，自定义模型时按当前可用 ID 添加即可。
- [DeerAPI 本站](https://apidoc.deerapi.com/integration/deerapi.md): DeerAPI 本站调用指南：登录获取 API Key 与接口 URL（https://api.deerapi.com），并通过 Try it out 或 Apifox 配置 headers 测试接口请求与成功响应。
- [Dify](https://apidoc.deerapi.com/integration/dify.md): DeerAPI Dify 集成指南：登录 DeerAPI 获取 API Key 与 Base URL，在 Dify 通过插件 deerapi 或 OpenAI 兼容配置接入，快速调用当前可用模型。
- [FastGPT](https://apidoc.deerapi.com/integration/fastgpt.md): DeerAPI FastGPT 集成指南：在 FastGPT 第三方账户选择 OpenAI，填写 baseurl https://api.deerapi.com/v1 并粘贴 DeerAPI API Key，完成配置与调用测试。
- [GPT Academic](https://apidoc.deerapi.com/integration/gpt-academic.md): DeerAPI GPT 学术优化（gpt_academic）集成指南：获取 DeerAPI API Key 与 baseurl，并在 config.py 配置 https://api.deerapi.com/v1/chat/completions 实现 Chat Completions 调用。
- [gptme](https://apidoc.deerapi.com/integration/gptme.md): DeerAPI gptme 集成指南：下载 gptme 后在 config.toml 配置 baseurl（https://api.deerapi.com/v1）与 DeerAPI API Key，并完成调用测试排查。
- [沉浸式翻译](https://apidoc.deerapi.com/integration/immersive-translate.md): DeerAPI 沉浸式翻译集成指南：教你在浏览器扩展中添加 OpenAI 兼容服务，填写 baseurl 与 DeerAPI API Key，配置 chat/completions 接口并测试翻译调用。
- [IntelliJ Translation Plugin](https://apidoc.deerapi.com/integration/intellij-translation-plugin.md): DeerAPI IntelliJ Translation Plugin 集成指南：在 IntelliJ IDEA 安装插件后，配置 OpenAI 翻译端点与 API Key，完成翻译调用测试并可新增自定义模型 ID。
- [LangChain](https://apidoc.deerapi.com/integration/langchain.md): DeerAPI LangChain 集成指南：获取 DeerAPI API Key 与 baseurl，配置环境变量或编译器参数，使用 https://api.deerapi.com/v1 完成 LangChain API 调用测试。
- [懒人客服](https://apidoc.deerapi.com/integration/lazy-service.md): DeerAPI 懒人客服接入指南：下载懒人客服后，在设置中选择 OpenAI，将 baseurl 填写 https://api.deerapi.com 并粘贴 DeerAPI API Key 完成配置。
- [LibreChat](https://apidoc.deerapi.com/integration/librechat.md): DeerAPI LibreChat 集成指南：获取 DeerAPI API Key 并在 LibreChat 的 OpenAI 设置中填写 baseurl https://api.deerapi.com 与 key，完成 API 配置与调用测试。
- [Lobe Chat](https://apidoc.deerapi.com/integration/lobe-chat.md): DeerAPI Lobe-Chat 集成指南：下载 Lobe-Chat 后在设置中选择 OpenAI API，填写 baseurl https://api.deerapi.com 与 DeerAPI API Key 完成配置并测试调用。
- [NextChat](https://apidoc.deerapi.com/integration/next-chat.md): DeerAPI 集成 NEXT CHAT（ChatGPT Next Web）教程：获取 DeerAPI API Key 并设置 baseurl 为 https://api.deerapi.com，按 OpenAI API 配置完成调用测试与自定义模型名称。
- [Obsidian Text Generator](https://apidoc.deerapi.com/integration/obsidian-text-gen.md): DeerAPI 教你在 Obsidian 的 Text Generator 插件中配置 openai chat：获取 DeerAPI API Key 与 base url，填写 https://api.deerapi.com/v1 并测试调用，快速接入 AI 对话模型。
- [Open WebUI](https://apidoc.deerapi.com/integration/open-webui.md): DeerAPI 集成 Open WebUI 教程：在管理员面板外部连接处填写 https://api.deerapi.com/v1 与 DeerAPI API Key，快速接入 GPT、DeepSeek 等主流大模型，完成调用测试。
- [OpenAI Translator](https://apidoc.deerapi.com/integration/openai-translator.md): DeerAPI 集成 OpenAI Translator 教程：下载插件后在设置中填写 DeerAPI baseurl 与 API key，完成翻译调用测试，并支持自定义当前模型 ID。
- [OpenClaw](https://apidoc.deerapi.com/integration/openclaw.md): DeerAPI 配置 OpenClaw 接入 AI 大模型：提供 OpenAI/Claude/Gemini 统一接口，给出安装命令、环境变量API Key管理与 openclaw.json Provider/Base URL 配置示例（2026.3.8+）。
- [OpenManus](https://apidoc.deerapi.com/integration/openmanus.md): DeerAPI OpenManus 集成指南：部署 OpenManus 后获取 API Key，在 config.toml 中配置 baseurl https://api.deerapi.com/v1 与 key，完成 API 调用测试。
- [欧陆翻译](https://apidoc.deerapi.com/integration/ouluyi.md): DeerAPI 欧陆翻译集成指南：下载欧陆翻译后获取 API Key，按步骤将翻译引擎设为 OpenAI 并填写 API host 与API Key，完成 API 配置与调用测试。
- [Pot 翻译](https://apidoc.deerapi.com/integration/pot-translate.md): DeerAPI Pot 翻译接入指南：下载 Pot 后获取 DeerAPI API Key，按步骤在服务设置中选择 OpenAI，配置 chat/completions 地址与 API Key，实现 Pot 翻译 API 调用。
- [STranslate](https://apidoc.deerapi.com/integration/stranslate.md): DeerAPI STranslate 集成指南：下载安装 STranslate，获取 DeerAPI API Key 与 baseurl，按 DeerAPI/OpenAPI 两种方式配置当前模型，完成翻译调用测试。
- [utools-ChatGPT 好友](https://apidoc.deerapi.com/integration/utools-chatgpt.md): DeerAPI utools-ChatGPT 好友插件接入指南：获取 DeerAPI API Key 与 baseurl，并在插件中配置接口地址 https://api.deerapi.com 与 API Key 完成调用。
- [Zotero](https://apidoc.deerapi.com/integration/zotero.md): DeerAPI Zotero 集成指南：下载安装 Zotero 与 zotero-gpt 插件，获取 DeerAPI API Key 并配置 baseurl https://api.deerapi.com，选择模型后完成调用测试实现翻译对话。
- [关于分组](https://apidoc.deerapi.com/pricing/groups.md): DeerAPI 关于分组页面，说明 Default 默认分组、Claude 纯官分组等用途与适用范围，帮助选择高并发稳定的 Claude 官方API调用方案。
- [关于价格](https://apidoc.deerapi.com/pricing/overview.md): DeerAPI 关于价格：支持 OpenAI、Claude 等按 Token 1:1 官方计费，充值默认 7 折；Midjourney、Suno 等无官方 API 模型按次计费，并提供各大模型官网定价参考链接。
- [入门必看](https://apidoc.deerapi.com/quick-start/intro.md): DeerAPI 入门必看指南：注册即送0.1美元、微信支付宝充值、生成 OpenAI/Claude/Gemini Key、切换模型与 Base URL 选择、按量计费与Token日志查询。
- [快速开始](https://apidoc.deerapi.com/quick-start/quick-start.md): DeerAPI 快速开始：三步完成接入，充值获取 Key，替换 Base URL 为 https://api.deerapi.com，并在客户端替换 Key，快速调用统一 AI API。

## OpenAPI Specs

- [post-veo3-async.openapi](https://apidoc.deerapi.com/api/openapi/video/veo3/async/post-veo3-async.openapi.json)
- [get-veo3-query.openapi](https://apidoc.deerapi.com/api/openapi/video/veo3/async/get-veo3-query.openapi.json)
- [post-generate.openapi](https://apidoc.deerapi.com/api/openapi/image/flux/post-generate.openapi.json)
- [post-seedream.openapi](https://apidoc.deerapi.com/api/openapi/image/doubao/post-seedream.openapi.json)
- [post-chat.openapi](https://apidoc.deerapi.com/api/openapi/text/openai/post-chat.openapi.json)
- [post-responses.openapi](https://apidoc.deerapi.com/api/openapi/text/openai/post-responses.openapi.json)
- [post-embeddings.openapi](https://apidoc.deerapi.com/api/openapi/text/openai/post-embeddings.openapi.json)
- [get-models.openapi](https://apidoc.deerapi.com/api/openapi/text/openai/get-models.openapi.json)
- [post-gemini-text.openapi](https://apidoc.deerapi.com/api/openapi/text/gemini/post-gemini-text.openapi.json)
- [post-anthropic-messages.openapi](https://apidoc.deerapi.com/api/openapi/text/anthropic/post-anthropic-messages.openapi.json)
- [post-veo3-chat.openapi](https://apidoc.deerapi.com/api/openapi/video/veo3/post-veo3-chat.openapi.json)
- [post-remix-video.openapi](https://apidoc.deerapi.com/api/openapi/video/sora-2/official/post-remix-video.openapi.json)
- [post-create-video.openapi](https://apidoc.deerapi.com/api/openapi/video/sora-2/official/post-create-video.openapi.json)
- [get-search-video.openapi](https://apidoc.deerapi.com/api/openapi/video/sora-2/official/get-search-video.openapi.json)
- [get-download-video.openapi](https://apidoc.deerapi.com/api/openapi/video/sora-2/official/get-download-video.openapi.json)
- [post-video2video.openapi](https://apidoc.deerapi.com/api/openapi/video/runway/compat/post-video2video.openapi.json)
- [post-generate-262418.openapi](https://apidoc.deerapi.com/api/openapi/video/runway/compat/post-generate-262418.openapi.json)
- [post-feed.openapi](https://apidoc.deerapi.com/api/openapi/video/runway/compat/post-feed.openapi.json)
- [post-act-one.openapi](https://apidoc.deerapi.com/api/openapi/video/runway/compat/post-act-one.openapi.json)
- [post-video-gen.openapi](https://apidoc.deerapi.com/api/openapi/video/minimax/post-video-gen.openapi.json)
- [get-query-task.openapi](https://apidoc.deerapi.com/api/openapi/video/minimax/get-query-task.openapi.json)
- [get-download.openapi](https://apidoc.deerapi.com/api/openapi/video/minimax/get-download.openapi.json)
- [get-query.openapi](https://apidoc.deerapi.com/api/openapi/video/luma/official/get-query.openapi.json)
- [post-video-effects.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-video-effects.openapi.json)
- [post-text-to-video.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-text-to-video.openapi.json)
- [post-omni-video.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-omni-video.openapi.json)
- [post-multi-img-to-video.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-multi-img-to-video.openapi.json)
- [post-lipsync-face.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-lipsync-face.openapi.json)
- [post-lipsync-create.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-lipsync-create.openapi.json)
- [post-image-to-video.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-image-to-video.openapi.json)
- [post-extend-video.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-extend-video.openapi.json)
- [post-avatar-create.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/post-avatar-create.openapi.json)
- [post-remove-mask.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/multimodal-edit/post-remove-mask.openapi.json)
- [post-preview-mask.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/multimodal-edit/post-preview-mask.openapi.json)
- [post-init-video.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/multimodal-edit/post-init-video.openapi.json)
- [post-create-task.openapi](https://apidoc.deerapi.com/api/openapi/image/replicate/post-create-task.openapi.json)
- [post-clear-mask.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/multimodal-edit/post-clear-mask.openapi.json)
- [post-add-mask.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/multimodal-edit/post-add-mask.openapi.json)
- [get-omni-query.openapi](https://apidoc.deerapi.com/api/openapi/video/kling/get-omni-query.openapi.json)
- [post-upload-music.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-upload-music.openapi.json)
- [post-song-concat.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-song-concat.openapi.json)
- [post-single-track-separate.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-single-track-separate.openapi.json)
- [post-query-batch.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-query-batch.openapi.json)
- [post-new-persona.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-new-persona.openapi.json)
- [post-get-vox.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-get-vox.openapi.json)
- [post-generate-music.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-generate-music.openapi.json)
- [post-generate-lyrics.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-generate-lyrics.openapi.json)
- [post-full-track-separate.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-full-track-separate.openapi.json)
- [post-expand-style-tags.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/post-expand-style-tags.openapi.json)
- [get-query-single.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/get-query-single.openapi.json)
- [get-lyrics-timeline.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/get-lyrics-timeline.openapi.json)
- [get-get-wav.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/get-get-wav.openapi.json)
- [get-get-midi.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/get-get-midi.openapi.json)
- [get-generate-mv.openapi](https://apidoc.deerapi.com/api/openapi/music/suno/get-generate-mv.openapi.json)
- [post-images.openapi](https://apidoc.deerapi.com/api/openapi/image/openai/post-images.openapi.json)
- [post-image-edit.openapi](https://apidoc.deerapi.com/api/openapi/image/openai/post-image-edit.openapi.json)
- [post-paginate.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/tasks/post-paginate.openapi.json)
- [get-get-by-id.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/tasks/get-get-by-id.openapi.json)
- [post-submit-video.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-video.openapi.json)
- [post-submit-modal.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-modal.openapi.json)
- [post-submit-imagine.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-imagine.openapi.json)
- [post-submit-edit.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-edit.openapi.json)
- [post-submit-describe.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-describe.openapi.json)
- [post-submit-blend.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-blend.openapi.json)
- [post-submit-action.openapi](https://apidoc.deerapi.com/api/openapi/image/midjourney/post-submit-action.openapi.json)
- [post-virtual-try-on.openapi](https://apidoc.deerapi.com/api/openapi/image/kling/post-virtual-try-on.openapi.json)
- [post-multi-img-gen.openapi](https://apidoc.deerapi.com/api/openapi/image/kling/post-multi-img-gen.openapi.json)
- [post-image-recognition.openapi](https://apidoc.deerapi.com/api/openapi/image/kling/post-image-recognition.openapi.json)
- [post-image-gen.openapi](https://apidoc.deerapi.com/api/openapi/image/kling/post-image-gen.openapi.json)
- [post-expand-img.openapi](https://apidoc.deerapi.com/api/openapi/image/kling/post-expand-img.openapi.json)
- [post-gemini-image.openapi](https://apidoc.deerapi.com/api/openapi/image/gemini/post-gemini-image.openapi.json)
- [post-generate-558509.openapi](https://apidoc.deerapi.com/api/openapi/image/flux/post-generate-558509.openapi.json)
- [post-create-task-replicate.openapi](https://apidoc.deerapi.com/api/openapi/image/flux/post-create-task-replicate.openapi.json)
- [post-seededit.openapi](https://apidoc.deerapi.com/api/openapi/image/doubao/post-seededit.openapi.json)
- [post-tts.openapi](https://apidoc.deerapi.com/api/openapi/audio/openai/post-tts.openapi.json)
- [post-translation.openapi](https://apidoc.deerapi.com/api/openapi/audio/openai/post-translation.openapi.json)
- [post-stt.openapi](https://apidoc.deerapi.com/api/openapi/audio/openai/post-stt.openapi.json)
- [post-voice-tts.openapi](https://apidoc.deerapi.com/api/openapi/audio/kling/post-voice-tts.openapi.json)
- [post-video-to-sfx.openapi](https://apidoc.deerapi.com/api/openapi/audio/kling/post-video-to-sfx.openapi.json)
- [post-text-to-sfx.openapi](https://apidoc.deerapi.com/api/openapi/audio/kling/post-text-to-sfx.openapi.json)


Built with [Mintlify](https://mintlify.com).