平台开放接口

高可用相关接口

动态获取API地址

对于可用性要求较高的用户，CloseAI提供了动态获取API地址的方式，避免单个域名不可用时导致生产损失，此接口需要通过独立的专用域名访问，且携带平台提供的API Key。接口有限流，不可频繁调用。请对接口返回内容做好缓存，不要每次请求都查询API Base，检测接口有效性应通过健康状态API检测。

接口中的priority提示了该API的推荐优先级，数字越大，越推荐作为优先选择。优先级低仅作为紧急时刻备用选择，替换频率较高。

请求

curl --location --request GET 'https://api.shadowai.xyz/api/v1/links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer sk-xxxx'

响应

[
    {
        "api": "https://api.xxxx.org",
        "desc": "主API",
        "priority": 10,
        "status": "ok"
    },
    {
        "api": "https://api.xxxx.xyz",
        "desc": "紧急备用API，随时替换，请勿过渡依赖",
        "priority": 1,
        "status": "ok"
    }
]

查询API健康状态

通过动态API查询接口返回的API地址，可以通过以下接口查询API健康状态，能正常访问时，说明域名处于健康状态。可以正常提供服务。接口有限流，请合理设置检查频率。不要频繁检查可用性，建议5分钟检测一次即可。

请求

curl --location --request GET '{API Base}/api/v1/healthy' \
--header 'Content-Type: application/json'

响应

healthy