Docs

开发者接入文档

这里仅覆盖 soulomapi 当前已经真实上线的接入能力,包括基础地址、鉴权方式、快速接入步骤、示例请求和常见错误。

Base URLhttps://apilink.soulom.xyz

鉴权方式

/v1/* 接口使用控制台创建的 API Key,通过 Authorization: Bearer sk-*** 传递。

支持范围

当前已开放 GET /v1/models POST /v1/chat/completions,且仅支持非流式 chat completions。

控制台域名

控制台和文档位于 https://api.soulom.xyz,API 网关位于 https://apilink.soulom.xyz

Endpoint Index
开发者调用
  • GET /v1/models
  • POST /v1/chat/completions
控制台接口
  • POST /api/auth/register
  • POST /api/auth/login
  • GET /api/me
  • GET /api/api-keys
  • POST /api/api-keys
  • POST /api/recharge/orders
Quick Start

Step 1

注册并登录控制台

访问 api.soulom.xyz,完成账号注册与登录,进入控制台。

Step 2

创建 API Key

在控制台生成 API Key,原始密钥只展示一次,请立即保存。

Step 3

充值可用余额

先完成充值,再调用模型接口,余额不足时请求会直接返回错误。

Step 4

先拉取模型列表

通过 /v1/models 获取当前可用模型,再选择具体模型发起请求。

Step 5

调用 Chat Completions

使用 OpenAI 兼容格式调用 /v1/chat/completions,当前仅支持非流式请求。

Request Examples

curl

先调用模型列表确认可用模型,再按 OpenAI 兼容格式请求 chat completions。

curl https://apilink.soulom.xyz/v1/models \
  -H "Authorization: Bearer sk-***"

curl https://apilink.soulom.xyz/v1/chat/completions \
  -H "Authorization: Bearer sk-***" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5.4",
    "messages": [
      {"role": "system", "content": "You are helpful."},
      {"role": "user", "content": "hello"}
    ]
  }'

Python

from openai import OpenAI

client = OpenAI(
    api_key="sk-***",
    base_url="https://apilink.soulom.xyz/v1",
)

response = client.chat.completions.create(
    model="openai/gpt-5.4",
    messages=[
        {"role": "system", "content": "You are helpful."},
        {"role": "user", "content": "hello"},
    ],
)

print(response.choices[0].message.content)

Node.js

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-***",
  baseURL: "https://apilink.soulom.xyz/v1",
});

const response = await client.chat.completions.create({
  model: "openai/gpt-5.4",
  messages: [
    { role: "system", content: "You are helpful." },
    { role: "user", content: "hello" },
  ],
});

console.log(response.choices[0]?.message?.content);
Common Errors
401unauthorized

API Key 缺失、格式不正确或已失效。

402insufficient_balance

账户余额不足,请先充值再发起请求。

404model_not_found

请求的模型当前不可用或名称不存在。

500openrouter_not_configured

服务端上游配置缺失,属于服务侧配置问题。

502 / 504upstream_connection_error / upstream_timeout

上游 OpenRouter 网络异常或超时,可稍后重试。

接入提醒
文档只描述当前已经真实实现的能力,不包含未来计划中的流式输出、退款或套餐体系。
如果你要从控制台查看余额、创建 Key、充值或管理请求日志,请登录 api.soulom.xyz
生产环境建议显式配置 SOULOMAPI_API_BASE_URL,站点会默认回退到 https://apilink.soulom.xyz,避免误连本地地址。