指南总览
- 从跑通第一条请求,到把服务稳定跑在线上
- 四篇:一篇管上手,一篇管工程,两篇给下游中转商
- 遇到具体接口问题,去 API 手册里查
各篇指南的分工
| 指南 | 解决的问题 | 适合谁 |
|---|---|---|
| 快速开始 | 五分钟内拿到第一个回复 | 第一次接触的人 |
| 开发指南 | 重试、超时、幂等、流式解析、成本控制 | 要把服务上线的人 |
| OAI Route 接入 | 搭建 New API 站点,并添加 OAIRoute 的 API 渠道 | 下游中转商 |
| Ark Global 接入 | 在自己的中转站配置 Ark 的渠道、插件和价格 | 下游中转商 |
| Guide | Problem it solves | Who it's for |
|---|---|---|
| Quick start | Get your first response in five minutes | First-time users |
| Development guide | Retries, timeouts, idempotency, stream parsing, cost control | People shipping to production |
| OAI Route reseller setup | Stand up a New API platform and add OAIRoute API channels | Resellers |
| Ark Global reseller setup | Configure Ark channels, plugins, and pricing on your own platform | Resellers |
该从哪篇看起
只想试一下:看快速开始。三步就能拿到回复,不需要读别的内容。
准备接进生产:两篇都看。快速开始给的是最小可行请求,开发指南补的是工程上必须处理的边界。
已经在用、遇到问题:直接看常见问题里的「连接与使用问题」。那里按报错类型分了类。
Just trying it out: read Quick start. Three steps get you a response; nothing else is required.
Heading to production: read both. Quick start gives you the minimal working request; the development guide covers the edge cases you have to handle.
Already using it and hitting problems: jump to "Connection and usage" in the FAQ. It's organized by error type.
三条最容易被忽略的原则
地址带不带 /v1 因客户端而异。 同一个值填错位置就是 404。不确定时先用 curl 验证端点本身通不通。
异步任务要设总超时。 图像、视频都是提交后轮询,没有超时的轮询循环会永久阻塞。
结果要立刻转存。 生成的图片和视频链接带过期时间,平台不提供长期归档。
Whether the base URL includes /v1 depends on the client. The same value in the wrong place is a 404. When unsure, use curl to verify the endpoint itself works.
Set an overall timeout for async tasks. Image and video generation are submit-then-poll; a polling loop without a timeout will block forever.
Copy results promptly. Generated image and video links expire; the platform keeps no long-term archive.
相关页面
- 第一次调用:快速开始
- 工程实践:开发指南
- 接口细节:API 手册
- 下游接入 OAI Route:OAI Route 接入
- 下游接入 Ark Global:Ark Global 接入
- 报错排查:常见问题 → 连接与使用问题
- 省钱:常见问题 → 成本优化
- First call: Quick start
- Engineering practices: Development guide
- Endpoint details: API manual
- OAI Route reseller setup: OAI Route reseller setup
- Ark Global reseller setup: Ark Global reseller setup
- Troubleshooting: FAQ → Connection and usage
- Saving money: FAQ → Cost optimization