快速开始
在几分钟内发出第一个 orientx API 请求
orientx 通过一个兼容 OpenAI 的接入点提供多种模型。如果你已有调用 OpenAI API 的代码， 只需修改 Base URL 和 API 密钥，即可接入 orientx。
| Base URL | https://api.orientx.ai/v1 |
| 身份验证 | Authorization: Bearer <ORIENTX_API_KEY> |
| 格式 | OpenAI Chat Completions |
本指南中的示例使用 <MODEL_ID> 作为占位符。打开模型价格页面，
查看可用模型并复制可直接运行的 API 示例。
发出第一个请求
调用 API
curl https://api.orientx.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ORIENTX_API_KEY" \
-d '{
"model": "<MODEL_ID>",
"messages": [
{ "role": "user", "content": "In one sentence, what is an API gateway?" }
]
}'调用成功后，会返回标准的 Chat Completions 格式：
{
"id": "chatcmpl-...",
"object": "chat.completion",
"model": "<MODEL_ID>",
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "An API gateway is a single entry point that routes and manages requests to backend services."
}
}
],
"usage": { "prompt_tokens": 18, "completion_tokens": 21, "total_tokens": 39 }
}使用 OpenAI SDK
API 遵循 OpenAI 的数据结构，因此官方 SDK 无需修改即可使用。设置 base_url 和
api_key，其余代码保持不变。详细步骤参见 OpenAI SDK。
pip install openai同样修改这两个字段，也可接入 Claude Code、Codex、Cursor、Gemini CLI、OpenCode 等 IDE 和应用：
流式响应
设置 stream: true，即可在 token 生成时逐步接收，而不用等待完整响应。
流以服务器发送事件（SSE）的形式传输，并以 data: [DONE] 结束。
stream = client.chat.completions.create(
model="<MODEL_ID>",
messages=[{"role": "user", "content": "Write a haiku about latency."}],
stream=True,
)
for chunk in stream:
delta = chunk.choices[0].delta.content
if delta:
print(delta, end="", flush=True)列出可用模型
GET /v1/models 返回当前密钥可访问的所有模型。请求中的 model 应使用返回的 id 字段。
curl https://api.orientx.ai/v1/models \
-H "Authorization: Bearer $ORIENTX_API_KEY"