按身份查找 HTTP 接口
按调用身份与业务域查找完整 HTTP 参数、响应、错误、幂等和可执行样例。
先选择调用身份,再查所属业务域。每章包含请求位置与字段约束、嵌套响应、状态码、示例和失败恢复;本页负责索引,不再把一个接口压缩成一句简介。
从完整场景开始
媒体生成:完整调用链与接口详解 是完整样板:服务发现 → 素材上传 → 可选提示词优化 → 创建 → 查询与恢复 → 下载。覆盖 HTTP、Python、H3四模式及图片/视频/音频组合边界。
第一次接入可先看HTTP 接入指南;使用Python看SDK方法与类型参考。公网生成返回jobId字典,正式应用create_job返回RuntimeJob;不能交叉复制正文或取值方式。
按业务域查接口
| 参考章节 | 接口范围 | 重点区别 |
|---|---|---|
| 媒体生成全链路 | assets/input、media/prompt-optimizations、media/generations、admission/preview、jobs、assets/content | 公网assetId、正式应用readUrl;幂等与任务恢复 |
| 公共 AI 接口 | services、openapi.json、models、voices、chat/SSE、embedding、rerank、OCR、ASR、图像、音频、文档 | 精确content-type、同步/异步和每种响应;模型差异 |
| 已部署应用 Runtime | available-services、同步推理、media/jobs、dry-run、batch-get、events、exports、resource-usage | params/mediaSpec/inputs正文;Session与Job恢复引用不能混用 |
| 会话与应用间授权 | runtime-sessions交换/解析/续期、组织目录、app-grants、inter-app | 一次性启动、身份边界、请求摘要和授权有效期 |
| 开发者应用与版本 | apps/roles/versions、source、changes、requests、镜像分片导入、校验提交、开发凭据 | 应用ownership、版本与工作副本、幂等及未知结果查询 |
地址与认证
| 场景 | 基础地址 | 身份来源 |
|---|---|---|
| 个人 Account API Key | https://api.jusuanhub.com:10443/v1 | 个人创建的API Key,Bearer |
| 应用联网调试 | https://app-api.jusuanhub.com:10443/v1 | CLI注入的短期调试令牌,Bearer |
| 应用本地模拟 | CLI注入的回环地址 | 模拟身份,不作为生产效果或计费验证 |
| 已部署应用 Runtime | 完整的 JUSP_APP_RUNTIME_BASE_URL | 托管应用凭据 + 用户RuntimeSession;已有任务可用限定恢复引用 |
| 已部署应用会话 | 完整的 JUSP_APP_SESSION_BASE_URL | 与appKey匹配的托管应用凭据 |
| 开发者控制面 | https://app-api.jusuanhub.com:10443,再拼 /api/v1/appstore/developer | 有效开发者会话;仅明示支持的操作接受对应短期开发令牌 |
基础地址已有前缀时不要再补/v1。每章中的相对路径与所属身份配对。托管凭据仅在后端读取平台注入文件,不能写进源码、浏览器URL、日志或镜像。个人、调试、应用运行的素材与权限不互通。
请求、错误与安全恢复
无请求体、multipart、JSON、SSE和二进制输出分别按各操作说明处理,没有所有接口共用的成功信封。例如公网服务列表是data,正式服务列表是items,上传是asset,任务是直接对象;SDK可能归一它们,不能反推HTTP正文。
错误读取机器code、受控message、requestId及适用的phase/retryable/Retry-After;只有服务明确提供时才使用这些可选字段。400/422修正输入,401恢复授权,402检查额度,403停止越权动作,404核对原ID,409读取现有状态,429按提示退避。HTTP成功不等于异步任务成功。
模型调用可能计费。写结果未知时,先查询已取得的任务/版本/上传会话;需要重放的幂等操作保持同身份、同业务键、同正文。不能用新键无限重试,不能靠更短超时“提速”。会话交换等一次性动作采用自己的恢复规则,不套通用重试。
可下载合同与兼容
- 开发者 OpenAPI 3.1 YAML:公共AI、正式Runtime、会话与开发者操作的完整机器合同;同名路径的身份分支有各自servers与schema。
- 公共 AI OpenAPI JSON:由网关公开合同直接导出;运行时/openapi.json提供对应在线定义。
- 应用中心模块 PDF 与 个人用户完整手册 PDF:来自同一正文。
OpenAPI的文档版本不是SDK包版本。精确安装版本使用应用开发者工作台实时生成的命令;服务参数还需结合当前能力合同。旧参考链接保留为本索引,详细字段以链接章节为准,不维护第二套缩略协议。