FrameAI 计划提供面向企业官网、业务系统、自动化工作流和合作伙伴的开放平台 API。开放 API 的目标是让第三方能够在自身产品中完成素材上传、发起视频生成、跟踪异步任务并接收结果通知，而不需要模拟用户在 PC 应用端或 Web 网站端中的操作。

规划中

本专区定义的是对外开放前的目标能力和 v1 合同草案。当前客户端内的“API”页面及 Gateway 内部路由不代表已经可公开申请、稳定调用或用于生产集成；正式上线时将以发布公告、开发者控制台和版本化参考文档为准。

目标使用场景

场景	第三方系统动作	FrameAI 返回内容
企业内容生产系统	提交素材与生成参数，批量创建视频任务。	任务 ID、状态、生成结果和稳定错误码。
营销自动化工作流	在活动节点触发视频生成，等待回调继续发布流程。	Webhook 事件和可验证签名。
自有创作工具	查询已开放模型，调用视频生成并展示任务进度。	模型目录、异步任务状态和资源地址。
资产管理系统	上传参考图或读取已经生成的结果。	资产 ID、类型、状态与授权范围内的访问地址。

开放能力边界

开放 API 以稳定、可计费、可审计的用户能力为边界，不公开内部微服务接口、服务间令牌、数据库结构、运营后台操作或平台级模型密钥。

目标 v1 能力	对外形态	说明
应用与密钥管理	开发者控制台	创建应用、查看作用域、轮换和撤销密钥。
模型查询	GET /open/v1/models	返回调用方账户已获授权的模型和能力，不暴露内部渠道配置。
素材上传	POST /open/v1/assets/uploads	取得受限上传凭据或提交符合规则的资源。
视频生成	POST /open/v1/video/generations	创建异步生成任务，返回任务 ID。
任务与结果	GET /open/v1/tasks/{task_id}	查询状态、错误与结果资产。
回调通知	Webhook	推送任务成功、失败等终态事件，并附带签名。

接口路径、字段和错误码在公测前可能调整；对外发布后只会在显式的新 API 版本中引入破坏性变更。

接入路径

1. 合作方在开发者控制台创建应用，选择所属工作空间和所需作用域。
2. 平台审核应用用途、额度与回调域名，随后签发仅展示一次的 API 密钥。
3. 调用方先在沙箱环境测试模型查询、素材上传、任务提交和回调验签。
4. 通过生产接入验收后，切换到生产基础地址并配置正式额度、限流和告警。
5. 使用请求 ID、任务 ID 和审计日志持续追踪调用；密钥泄露时立即轮换并撤销旧密钥。

申请与快速接入从应用创建、密钥保管到一次完整的异步生成调用。v1 接口合同草案查看目标端点、请求响应、任务状态、错误码和幂等要求。Webhook 与安全使用签名、时间戳、重放保护和重试规则处理终态通知。平台实现清单为后端、网关和开发者控制台准备可验收的开放 API 上线计划。

下一步：申请与快速接入。

上一页双端协同与排障

下一页申请与快速接入