Spicy API

面向开发者的 Spicy API

依托 Spicy 系列模型构建文本转视频与文生图体验。使用 API Key 鉴权、实时获取进度并在数分钟内交付结果。

为什么选择 Spicy API

流式进度、可选 Webhook 与自动存储上传,让你快速上线稳定的视频与图片生成能力。

实时流式进度

通过 Server-Sent Events 持续接收状态、进度和最终地址,让前端体验始终同步。

异步 Webhook 支持

配置 Webhook 终点即可在生成完成时自动接收结果,无需保持长连接。

透明可控的计费

视频调用消耗 10 积分,图片调用消耗 5 积分。失败任务会自动退款,方便统计成本。

鉴权与基础地址

所有接口均部署在 https://spicyai.site/api 域名下。请在请求头通过 Authorization 传入在控制台创建的 API Key。

  • 为每个请求添加 Authorization: Bearer YOUR_API_KEY。
  • 提交 JSON 时请设置 Content-Type: application/json。
  • 视频生成会扣除 10 积分,图片生成会扣除 5 积分,失败任务会自动返还。

核心接口

先创建视频或图片生成任务,再通过流式或轮询方式获取结果。

创建 Spicy 视频

支持文本转视频与图生视频,触发一次新的生成任务。

请求方法: POST请求路径: /api/v1/video/create

参数说明

  • 必填。固定值为 "spicy-2-video",指定最新视频模型。
  • 必填。用自然语言描述你希望 Spicy 模型生成的画面。
  • 选填。图生视频模式下的 base64 图像 Data URL,将自动上传到存储。
  • 选填。支持 "9:16"(默认)或 "16:9"。
  • 选填。HTTPS 地址,任务成功后会推送完整结果。
  • 选填。Webhook 模式下设为 true 可关闭中间的 SSE 进度事件。

使用提示

  • 接口以 Server-Sent Events 流式返回,请保持连接并解析 progress 直至完成。
  • 提供 webHook 字段即可在任务完成后以 POST 方式异步收到最终负载。

请求示例

curl -X POST https://spicyai.site/api/v1/video/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -N \
  -d '{
    "model": "spicy-2-video",
    "prompt": "A cinematic shot of a futuristic city at sunset, captured in 4K."
  }'

SSE

data: {"id":"task-123","status":"running","progress":45}

data: {"id":"task-123","status":"succeeded","progress":100,"results":[{"url":"https://cdn.example.com/videos/task-123.mp4"}]}

创建 Spicy 图片

支持文本转图片与图生图,触发一次新的图片生成任务。

请求方法: POST请求路径: /api/v1/image/create

参数说明

  • 必填。可选 "spicy-2-image-fast"(Spicy 2 Image Fast)或 "spicy-2-image"(Spicy 2 Image)。
  • 必填。描述你想生成的图片内容。
  • 选填。描述希望规避的元素。
  • 选填。图生图模式下的 base64 图像 Data URL,会自动上传存储。
  • 选填。如已有公网图片地址,可直接传入 HTTPS URL。
  • 选填。支持 "auto"、"1:1"、"4:5"、"3:4"、"4:3"、"3:2"、"16:9"、"9:16"、"21:9" 等比例。
  • 选填。布尔值,用于声明生成内容是否公开;免费用户默认公开。

使用提示

  • 接口会立即返回任务 ID,可通过查询接口获取最终结果链接。
  • 模型字段支持 spicy-2-image-fast(Spicy 2 Image Fast)与 spicy-2-image(Spicy 2 Image)。

请求示例

curl -X POST https://spicyai.site/api/v1/image/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "spicy-2-image-fast",
    "prompt": "Ultra detailed portrait of a cyberpunk explorer in neon rain, 8k, dramatic lighting",
    "aspectRatio": "1:1",
    "negativePrompt": "blurry, low quality, watermark"
  }'

响应示例

{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "task-456",
    "is_public": true
  }
}

查询生成结果

当未订阅流式或 Webhook 时,用于轮询任务状态。

请求方法: POST请求路径: /api/video-generations/check-result

参数说明

  • 必填。创建任务时返回的唯一标识。

使用提示

  • 接口会校验任务归属,仅返回当前账号的任务数据。
  • 失败任务会自动退款,并在响应中返回 credits_refunded 等退款字段。

请求示例

curl -X POST https://spicyai.site/api/video-generations/check-result \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskId": "task-123"
  }'

响应示例

{
  "code": 0,
  "message": "Success",
  "data": {
    "status": "running",
    "progress": 45,
    "result_url": null,
    "result_urls": [],
    "failure_reason": null,
    "error_message": null,
    "credits_refunded": false
  }
}

1. 创建任务

发送 Spicy 接口,携带提示词与可选 Webhook,并保存返回的 taskId。

2. 跟踪进度

监听流式事件(视频)或调用查询接口,直到状态变为 succeeded 或 failed。

3. 分发成片

使用 result_url / result_urls 中已经上传到存储的地址向用户交付视频或图片。

常见问题

接口如何鉴权?

在控制台创建 API Key 后,以 Authorization: Bearer YOUR_API_KEY 发送请求,可随时在控制台轮换密钥。

流式返回包含哪些信息?

接口通过 Server-Sent Events 持续推送 JSON,每条 data 含 id、status、progress 及可选 results。持续读取直至收到 status "succeeded" 或 "failed"。

失败任务的积分如何处理?

系统会自动返还积分,并在查询结果中返回 refund_trans_no 与 credits_refunded=true,便于对账。

资源与支持

立即接入 Spicy API

几分钟内创建 API Key,开始生成电影级 AI 视频与高清图片。