OpenAPI v3

StarAdvice 开发者门户

为您的应用集成 AI 能力。图片生成、语音合成、文件处理 —— 统一的 API 接口,灵活的按量计费。

域名:https://star-advice.com 鉴权:X-API-Key 前缀:/openapi 模式:异步任务

API 产品

图片生成

AI 图片生成服务,支持文生图、参考图生成、多比例输出、高清档位。提交任务后异步获取结果。

POST /openapi/image/generations GET /openapi/image/generations/{taskId}

声音录制

录音会话管理服务,支持创建录音会话、上传音频样本、查询会话状态与结果。

GET /openapi/voice/recorder-sessions/{token} POST /openapi/voice/recorder-sessions/{token}/upload

文件上传

统一文件上传服务,支持图片、音频、文档等格式。上传后返回可直接访问的 CDN 地址。

POST /openapi/file/upload

5 分钟快速接入

1

获取 API Key

在平台控制台创建并保存您的 API Key

2

选择产品

确定要接入的能力:图片生成 / 声音录制

3

调用接口

在请求头传入 X-API-Key,调用对应接口

4

轮询结果

异步任务每 2~3 秒轮询一次,获取最终结果

5

上线使用

确认联调通过后,切换生产环境 API Key

鉴权方式

所有 OpenAPI 请求均需在 HTTP Header 中传入 X-API-Key

X-API-Key: pk-xxxxxxxxxxxxxxxx

API Key 可在 平台控制台 创建和管理。 未传入或 Key 无效时,接口返回 success=false 并附带错误信息。

调用模式:异步任务

当前所有 OpenAPI 均采用异步任务模式:调用创建接口后返回 taskId,需轮询查询接口获取最终结果。

状态含义操作建议
PENDING 任务已创建,等待执行 等待 2~3 秒后轮询
PROCESSING 任务执行中 继续每 2~3 秒轮询
SUCCESS 任务成功 读取结果数据,停止轮询
FAILED 任务失败 查看 errorMessage,调整参数后重试

通用响应结构

所有接口统一返回以下 JSON 结构:

字段类型说明
successboolean请求是否成功
error.codestring / null错误码,异常时统一返回 500
error.messagestring / null错误描述,内容以服务端实际返回为准
error.fieldErrorsarray / null字段级错误(当前 OpenAPI 暂未拆分,通常为 null)
dataobject / null成功时返回业务数据,失败时为 null
traceIdstring请求追踪 ID,排查问题时请提供给平台

准备好开始接入了吗?

查看交互式 API 文档,直接在线调试每个接口

打开 API 参考

常见问题

创建任务后为什么没有立刻返回图片?

图片生成是异步任务,创建接口只负责接单并返回 taskId,需要通过查询接口轮询获取最终结果。

一次请求会返回几张图?

当前版本固定为单次请求生成单张图片,查询结果只返回一个 imageUrl

任务多久超时?

当前平台默认在 2 分钟内完成轮询;如果上游长时间未完成,任务会被判定为失败并停止轮询。

需要排查问题,应该提供什么信息?

请提供接口返回的 traceId 字段,平台可以根据 traceId 快速定位请求链路。