# Yelu AI API

> OpenAI-compatible API documentation for chat, responses, images, embeddings, audio, vision, streaming, and tool calling through Yelu AI API.

## Docs

- [创建音频转录](https://docs.yelu.ai/zh/api-reference/audio-transcriptions.md): 使用兼容 OpenAI 的 Yelu Audio Transcriptions API 将音频转换为文本。
- [创建聊天补全](https://docs.yelu.ai/zh/api-reference/chat-completions.md): 使用消息、流式输出、工具、视觉与 JSON 输出生成兼容 OpenAI 的 Chat Completion。
- [创建 Embedding](https://docs.yelu.ai/zh/api-reference/embeddings.md): 将文本转换为向量，用于语义搜索、聚类、推荐与检索增强生成。
- [生成图像](https://docs.yelu.ai/zh/api-reference/images.md): 通过兼容 OpenAI 的 Yelu Images API 根据文本提示生成图像。
- [列出模型](https://docs.yelu.ai/zh/api-reference/models.md): 以兼容 OpenAI 的格式列出当前 Yelu API Key 可以访问的 AI 模型。
- [创建响应](https://docs.yelu.ai/zh/api-reference/responses.md): 使用文本输入、工具、推理控制、流式传输与多轮延续创建模型响应。
- [鉴权](https://docs.yelu.ai/zh/authentication.md): 使用 Bearer Token 鉴权 Yelu AI API 请求，并在不同环境中安全管理 API Key。
- [更新日志](https://docs.yelu.ai/zh/changelog.md): 跟踪 Yelu AI API 已公开能力、文档与兼容性更新。
- [错误处理](https://docs.yelu.ai/zh/errors.md): 解析 Yelu AI API 错误、理解 HTTP 状态码并实现安全重试与可观测性。
- [聊天示例](https://docs.yelu.ai/zh/examples/chat.md): 构建完整的非流式聊天请求，并读取助手文本与 Token 用量。
- [Claude Code 示例](https://docs.yelu.ai/zh/examples/claude-code.md): 通过 Yelu 使用 Claude Code 完成仓库分析、功能实现、代码审查、自动化和项目级指令配置。
- [Codex CLI 示例](https://docs.yelu.ai/zh/examples/codex-cli.md): 通过 Yelu 使用 Codex CLI 安全完成仓库分析、功能实现、代码审查、图片输入和非交互自动化。
- [流式输出示例](https://docs.yelu.ai/zh/examples/streaming.md): 解析 Yelu Server-Sent Events 并实时渲染 Chat Completions 增量文本。
- [工具调用示例](https://docs.yelu.ai/zh/examples/tool-calling.md): 请求 Tool Call、校验参数、返回工具结果，并生成最终回答。
- [视觉示例](https://docs.yelu.ai/zh/examples/vision.md): 使用兼容 OpenAI 的多模态 Chat Completions 请求分析图片。
- [常见问题](https://docs.yelu.ai/zh/faq.md): 解答 Yelu AI API 兼容性、模型、SDK、密钥、流式输出、工具与可靠性问题。
- [最佳实践](https://docs.yelu.ai/zh/guides/best-practices.md): 在 Yelu AI API 上构建可靠、安全、可观测且成本可控的生产应用。
- [Claude Code](https://docs.yelu.ai/zh/guides/claude-code.md): 在 macOS、Windows 原生环境与 WSL 2 中配置 Claude Code，通过 Anthropic Messages API 使用 Yelu AI API。
- [Codex CLI](https://docs.yelu.ai/zh/guides/codex-cli.md): 在 macOS、Windows 原生环境与 WSL 2 中配置 OpenAI Codex CLI，通过 Responses API 使用 Yelu AI API。
- [函数调用](https://docs.yelu.ai/zh/guides/function-calling.md): 使用 JSON Schema、参数校验和 Tool Result 安全地让模型请求应用函数。
- [流式响应](https://docs.yelu.ai/zh/guides/streaming.md): 通过 Server-Sent Events 流式接收 Yelu 模型输出，并在 Curl、JavaScript 与 Python 中安全解析。
- [结构化输出](https://docs.yelu.ai/zh/guides/structured-output.md): 使用 JSON Mode 或 JSON Schema 生成可靠结构，并在应用中校验每次响应。
- [视觉理解](https://docs.yelu.ai/zh/guides/vision.md): 通过 URL 或 Data URI 向支持视觉的模型发送图片与文本。
- [Yelu AI API 文档](https://docs.yelu.ai/zh/index.md): 通过一个兼容 OpenAI 的统一 API 使用聊天、Responses、图像、嵌入、音频、视觉、流式输出与工具调用。
- [快速开始](https://docs.yelu.ai/zh/quickstart.md): 使用 Curl、JavaScript Fetch、Python 或 OpenAI SDK 完成第一个 Yelu AI API 请求。
- [速率限制](https://docs.yelu.ai/zh/rate-limits.md): 使用指数退避、随机抖动、有限重试与账号级控制正确处理 Yelu API 请求限制。
- [Go SDK](https://docs.yelu.ai/zh/sdk/go.md): 使用官方 OpenAI Go SDK 和自定义 Base URL 调用 Yelu AI API。
- [JavaScript SDK](https://docs.yelu.ai/zh/sdk/javascript.md): 在 Node.js 中使用官方 OpenAI JavaScript SDK 调用 Yelu Chat、Responses 与流式输出。
- [Python SDK](https://docs.yelu.ai/zh/sdk/python.md): 使用官方 OpenAI Python SDK 调用 Yelu 的聊天、Responses、流式输出与错误处理。