跳转到主要内容
POST
  1. 提交后会返回 task_id。如果提供了 callback_url,当任务状态变为 finished 或 failed 时,系统会向 callback_url 发送 POST 请求。
  2. 无论是否提供 callback_url,都可以通过统一的查询任务状态接口获取结果。
视频背景移除会将一个视频中的主体与背景分离。结果可使用透明背景或纯色背景,并以你选择的容器和编码格式返回。

模型

  • poyo-ai/video-background-removal — 移除一个视频的背景

必填参数

  • video_url (string):源视频 URL。

可选参数

  • output_container_and_codec (string):mp4_h265、mp4_h264、webm_vp9、mov_h265、mov_proresks、mkv_h265、mkv_h264、mkv_vp9 或 gif。
  • preserve_audio (boolean):是否保留源音轨。
  • background_color (string):Transparent、Black、White、Gray、Red、Green、Blue、Yellow、Cyan、Magenta 或 Orange。区分大小写。

输出

任务完成后,files 中返回一个视频,file_type: video,按请求的 output_container_and_codec 编码。

示例

  • 透明背景,输出 WebM — 设置 video_url、background_color、output_container_and_codec、preserve_audio。
  • 绿幕,输出 MP4 — 设置 video_url、background_color、output_container_and_codec。

注意事项

  • 省略的可选字段使用供应商默认值。
  • 如需透明结果,请将 Transparent 与支持 Alpha 通道的容器搭配使用,例如 webm_vp9 或 mov_proresks。
  • PoYo 在提交前会读取视频时长。如果无法确定时长,提交会失败。

授权

Authorization
string
header
必填

所有 API 接口都需要 Bearer Token 认证。

创建 API Key:登录 PoYo,进入 仪表盘 → API 密钥(poyo.ai/zh/dashboard/api-key),点击创建 Key。

在请求头中添加:

请求体

application/json
model
enum<string>
必填

公开的模型标识。

可用选项:
poyo-ai/video-background-removal
input
object
必填
callback_url
string<uri>

可选的 Webhook URL,用于接收任务完成或失败通知。

响应

任务提交成功

code
enum<integer>
必填

业务状态码。200 表示成功,其他值都表示请求失败。请务必检查这个字段:部分参数校验错误会以 HTTP 200 返回,响应体里的 code 为 400。

  • 200:成功
  • 400:请求参数无效
  • 401:API Key 缺失或无效
  • 402:积分不足
  • 403:没有权限
  • 404:资源不存在
  • 408:请求超时
  • 429:请求频率超限
  • 500:服务器内部错误
  • 502:上游服务错误
  • 503:服务暂不可用

详见错误码。

可用选项:
200,
400,
401,
402,
403,
404,
408,
429,
500,
502,
503
示例:

200

data
object
必填