API REFERENCE

一份清晰、克制的 Router 兼容契约。

当前 Router 源码定义了 OpenAI/OpenRouter-compatible 的 /v1 与 /api/v1 接口。只有线上 OpenAPI 通过精确契约漂移门禁后，生产部署才可视为符合该契约；源码存在本身不是线上可用证据。

01/v1兼容 API 入口

02Bearer令牌认证模式

03SSE增量流式模式

接口前缀与部署事实。

OpenAI-compatible 客户端使用 https://api.octoryn.dev/v1。Router 源码还提供 /api/v1；Anthropic Messages 有意只位于 /api/v1/messages。生产使用前，运营方必须将线上 /openapi.json 与不可变源码契约进行精确比对并保留结果。

把源码、容器和线上契约视为三层独立证据展开详情
这是「接口前缀与部署事实。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
不能因为源码存在路由就推定生产已经支持展开详情
这是「接口前缀与部署事实。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
部署后通过 /healthz、/readyz 与 /status 检查进程和组件状态展开详情
这是「接口前缀与部署事实。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

推理端点。

两个兼容前缀都定义 Chat Completions、旧版 Completions、Responses、Embeddings、Moderations 与 Rerank。Chat Completions、Completions 和 Responses 定义了流式响应；Messages 在 /api/v1/messages 使用其原生事件结构。

POST /v1/chat/completions、/completions 与 /responses展开详情
这是「推理端点。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
POST /v1/embeddings、/moderations 与 /rerank展开详情
这是「推理端点。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
Anthropic-compatible Messages 使用 POST /api/v1/messages展开详情
这是「推理端点。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

目录与治理端点。

具有 route scope 的认证凭证可以读取模型、供应商和 Embedding 模型目录。路由模拟与有界、无内容的治理摘要由独立 scope 保护。

GET /v1/models、模型详情、模型端点与模型计数展开详情
这是「目录与治理端点。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
GET /v1/providers、供应商详情与 /v1/embeddings/models展开详情
这是「目录与治理端点。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
POST /v1/route/simulate 与 GET /v1/governance/summary 需要专用 scope展开详情
这是「目录与治理端点。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

为每个请求进行认证。

使用为目标客户或产品环境签发的 API key。兼容客户端会将其放入 Bearer 令牌认证；不要把凭证嵌入浏览器包、移动端二进制或源码仓库。

将密钥保存在受保护的服务端环境展开详情
这是「为每个请求进行认证。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
分离开发与生产凭证展开详情
这是「为每个请求进行认证。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
通过责任运营方轮换或撤销已暴露凭证展开详情
这是「为每个请求进行认证。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

按类别理解错误。

认证与授权失败需要修正凭证或策略；限流响应需要调整调用节奏；上游与服务故障则需要有上限、理解上下文的恢复方式。

不要原样重试无效认证或格式错误的请求展开详情
这是「按类别理解错误。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
对限流与瞬时故障使用退避展开详情
这是「按类别理解错误。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
记录状态、响应正文和可获得的关联元数据展开详情
这是「按类别理解错误。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

增量消费流式响应。

当所选路由支持并启用 streaming 时，按到达顺序处理服务器发送事件。客户端应处理取消、断连，以及在形成完整应用结果前结束的流。

不必等待完整响应即可渲染或处理增量输出展开详情
这是「增量消费流式响应。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
把断连与部分输出作为明确的应用状态展开详情
这是「增量消费流式响应。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
为长时间运行的流设置应用截止时间展开详情
这是「增量消费流式响应。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

将能力视为路由级契约。

工具、视觉、结构化输出等可选能力取决于路由和上游模型。即使供应商声明支持 Schema，也应在应用边界校验参数与输出。

生产使用前确认能力支持展开详情
这是「将能力视为路由级契约。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
执行工具前校验参数展开详情
这是「将能力视为路由级契约。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档
关键能力应保留回退路径展开详情
这是「将能力视为路由级契约。」能力的一部分。Octoryn 会把配置、执行结果与相关路由上下文保留在同一条受治理链路中，便于团队独立验证和审查。
查看实现文档

OCTORYN ROUTER

沿用现有 SDK 工作流。

了解如何配置 OpenAI SDK 与兼容客户端，无需加入 Router 专用应用框架。

打开 SDK 指南