跳转到主要内容
POST
/
v1
/
videos
/
generations
curl --request POST \
  --url https://api.foxapi.cc/v1/videos/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "topaz-upscale-video",
  "video_url": "https://example.com/input-video.mp4",
  "enhancement_model": "Proteus",
  "upscale_factor": 2
}
'
{
  "created": 1757165031,
  "id": "task-unified-1757165031-uyujaw3d",
  "model": "<string>",
  "object": "video.generation.task",
  "progress": 0,
  "status": "pending",
  "task_info": {
    "can_cancel": true,
    "estimated_time": 45
  },
  "type": "video"
}

Documentation Index

Fetch the complete documentation index at: https://docs.foxapi.cc/llms.txt

Use this file to discover all available pages before exploring further.

授权

Authorization
string
header
必填

所有接口均需要使用Bearer Token进行认证

使用时在请求头中添加:

Authorization: Bearer YOUR_API_KEY

请求体

application/json
model
string
默认值:topaz-upscale-video
必填

topaz-upscale-video:输入视频 URL,输出放大并增强后的视频

示例:

"topaz-upscale-video"

video_url
string
必填

待增强视频的公开 URL

说明:

  • 上游服务需要能够直接访问该地址
  • 会基于该视频输出放大并增强后的版本
示例:

"https://example.com/input-video.mp4"

enhancement_model
enum<string>
默认值:Proteus

增强模型名称

说明:

  • 默认 Proteus,适合大多数视频
  • Artemis 系列偏向降噪与锐化
  • Nyx 系列偏向噪点清理
  • Gaia 系列更适合渲染、动画或运动图形
  • Starlight 系列偏向生成式增强
可用选项:
Proteus,
Artemis HQ,
Artemis MQ,
Artemis LQ,
Nyx,
Nyx Fast,
Nyx XL,
Nyx HF,
Gaia HQ,
Gaia CG,
Gaia 2,
Starlight Precise 1,
Starlight Precise 2,
Starlight Precise 2.5,
Starlight HQ,
Starlight Mini,
Starlight Sharp,
Starlight Fast 1,
Starlight Fast 2
示例:

"Proteus"

upscale_factor
number
默认值:2

放大倍数

说明:

  • 取值范围 1-4
  • 2 表示宽和高都放大 2
必填范围: 1 <= x <= 4
示例:

2

target_fps
integer | null

目标帧率

说明:

  • 取值范围 16-60
  • 传入后会启用插帧

非必须不要传这个参数。

必填范围: 16 <= x <= 60
示例:

24

compression
number | null

压缩伪影去除强度

说明:

  • 取值范围 0.0-1.0
  • 不传时使用模型默认值

非必须不要传这个参数。

必填范围: 0 <= x <= 1
示例:

0.3

noise
number | null

降噪强度

说明:

  • 取值范围 0.0-1.0
  • 不传时使用模型默认值

非必须不要传这个参数。

必填范围: 0 <= x <= 1
示例:

0.2

halo
number | null

光晕抑制强度

说明:

  • 取值范围 0.0-1.0
  • 不传时使用模型默认值

非必须不要传这个参数。

必填范围: 0 <= x <= 1
示例:

0.15

grain
number | null

胶片颗粒强度

说明:

  • 取值范围 0.0-1.0
  • 不传时使用模型默认值

非必须不要传这个参数。

必填范围: 0 <= x <= 1
示例:

0.1

recover_detail
number | null

原始细节保留强度

说明:

  • 取值范围 0.0-1.0
  • 值越高,越倾向保留原始画面细节

非必须不要传这个参数。

必填范围: 0 <= x <= 1
示例:

0.35

h264_output
boolean
默认值:false

是否输出 H.264 编码视频

说明:

  • 默认 false,即输出 H.265
  • 设为 true 时输出 H.264

非必须不要传这个参数。

示例:

false

响应

任务创建成功

created
integer

任务创建时间戳

示例:

1757165031

id
string

任务ID

示例:

"task-unified-1757165031-uyujaw3d"

model
string

实际使用的模型名称

object
enum<string>

任务的具体类型

可用选项:
video.generation.task
progress
integer

任务进度百分比 (0-100)

必填范围: 0 <= x <= 100
示例:

0

status
enum<string>

任务状态

可用选项:
pending,
processing,
completed,
failed
示例:

"pending"

task_info
object

异步任务信息

type
enum<string>

任务的输出类型

可用选项:
video
示例:

"video"