PixVerse

App · 20 actions

Generate and transform videos and images, browse effects and voices, and retrieve generation results.

Actions

ActionWhat it does
Add sound effectsAdd sound effects in PixVerse.
Expand videoExpand video in PixVerse.
Extend videoExtend video in PixVerse.
Generate image from a templateGenerate image from a template in PixVerse.
Generate video between two framesGenerate video between two frames in PixVerse.
Generate video from an imageGenerate video from an image in PixVerse.
Generate video from referencesGenerate video from references in PixVerse.
Generate video from textGenerate video from text in PixVerse.
Get credit balanceGet credit balance in PixVerse.
Get image resultGet image result in PixVerse.
Get video resultGet video result in PixVerse.
List credit usageList credit usage in PixVerse.
List effect templatesList effect templates in PixVerse.
List text-to-speech speakersList text-to-speech speakers in PixVerse.
List video stylesList video styles in PixVerse.
Restyle videoRestyle video in PixVerse.
Upload imageUpload image in PixVerse.
Upload video or audioUpload video or audio in PixVerse.
Upscale videoUpscale video in PixVerse.
Verify uploaded audioVerify uploaded audio in PixVerse.

Add sound effects

Add sound effects in PixVerse.

Inputs

Source video IDsource_video_idnumber
Source video ID.At least 1.
Video media IDvideo_media_idnumber
Video media ID.At least 1.
Original sound switchoriginal_sound_switchtrue/false
Original sound switch.Default: false.
Sound effect contentsound_effect_contenttext
Sound effect content.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Expand video

Expand video in PixVerse.

Inputs

Source video IDsource_video_idnumber
Source video ID.At least 1.
Video media IDvideo_media_idnumber
Video media ID.At least 1.
Aspect ratioaspect_ratiotextRequired
Aspect ratio.One of: 16:9, 9:16, 21:9, 4:3, 3:4, 1:1.
QualityqualitytextRequired
Quality.One of: 720p, 1080p.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": []
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Extend video

Extend video in PixVerse.

Inputs

Source video IDsource_video_idnumber
Source video ID.At least 1.
Video media IDvideo_media_idnumber
Video media ID.At least 1.
ModelmodeltextRequired
Model.One of: v6.
PromptprompttextRequired
Prompt.
DurationdurationnumberRequired
Duration.From 1 to 15.
QualityqualitytextRequired
Quality.One of: 360p, 540p, 720p, 1080p.
Seedseednumber
Seed.From 0 to 2147483647.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Generate image from a template

Generate image from a template in PixVerse.

Inputs

Img IDsimg_idslistRequired
Img IDs.
Templatetemplate_idnumberRequired
Template ID.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "image_id": 1
    }
  }
}

Generate video between two frames

Generate video between two frames in PixVerse.

Inputs

ModelmodeltextRequired
Model.One of: v6, c1, v5.6, v5.
PromptprompttextRequired
Prompt.
DurationdurationnumberRequired
Duration.From 1 to 15.
QualityqualitytextRequired
Quality.One of: 360p, 540p, 720p, 1080p.
First frame imgfirst_frame_imgnumberRequired
First frame img.At least 1.
Last frame imglast_frame_imgnumberRequired
Last frame img.At least 1.
Generate audio switchgenerate_audio_switchtrue/false
Generate audio switch.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Generate video from an image

Generate video from an image in PixVerse.

Inputs

ModelmodeltextRequired
Model.One of: v6, c1, v5.6, v5.
PromptprompttextRequired
Prompt.
DurationdurationnumberRequired
Duration.From 1 to 15.
QualityqualitytextRequired
Quality.One of: 360p, 540p, 720p, 1080p.
Img idimg_idnumberRequired
Img id.At least 1.
Generate audio switchgenerate_audio_switchtrue/false
Generate audio switch.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Generate video from references

Generate video from references in PixVerse.

Inputs

ModelmodeltextRequired
Model.One of: v4.5, v5, v5.5, v5.6, v6, c1.
PromptprompttextRequired
Prompt.
DurationdurationnumberRequired
Duration.From 0 to 15.
QualityqualitytextRequired
Quality.One of: 360p, 540p, 720p, 1080p.
Seedseednumber
Seed.From 0 to 2147483647.
Aspect ratioaspect_ratiotextRequired
Aspect ratio.One of: 16:9, 9:16, 4:3, 3:4, 1:1, 2:3, 3:2, 21:9, auto.
Image referencesimage_referenceslist
Image references.
Video referencesvideo_referenceslist
Video references.
Reference modereference_modetext
Reference mode.One of: omni.
Generate audio switchgenerate_audio_switchtrue/false
Generate audio switch.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Generate video from text

Generate video from text in PixVerse.

Inputs

ModelmodeltextRequired
Model.One of: v6-max, c1, v6, v3.5, v4, v4.5, v5, v5-fast, v5.5, v5.6.
PromptprompttextRequired
Prompt.
DurationdurationnumberRequired
Duration.From 1 to 15.
QualityqualitytextRequired
Quality.One of: 360p, 540p, 720p, 1080p.
Seedseednumber
Seed.From 0 to 2147483647.
Aspect ratioaspect_ratiotext
Aspect ratio.One of: 16:9, 9:16, 4:3, 3:4, 1:1, 2:3, 3:2, 21:9.
Generate audio switchgenerate_audio_switchtrue/false
Generate audio switch.Default: false.
Generate multi clip switchgenerate_multi_clip_switchtrue/false
Generate multi clip switch.Default: false.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Get credit balance

Get credit balance in PixVerse.

Inputs

None.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "account_id": 1,
      "credit_monthly": 1,
      "credit_package": 1
    }
  }
}

Get image result

Get image result in PixVerse.

Inputs

Image IDimage_idtextRequired
Image ID.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "create_time": "example",
      "credits": 1,
      "customer_paths": {},
      "image_id": 1,
      "modify_time": "example",
      "outputHeight": 1,
      "outputWidth": 1,
      "path": "example",
      "prompt": "example",
      "prompt_translate": "example",
      "seed": 1,
      "status": 1,
      "template_id": 1,
      "url": "example"
    }
  }
}

Get video result

Get video result in PixVerse.

Inputs

Video IDvideo_idnumberRequired
Video ID.At least 1.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "aspect_ratio": "example",
      "create_time": "example",
      "credits": 1,
      "customer_paths": {},
      "duration": 1,
      "has_audio": false,
      "id": 1,
      "modify_time": "example",
      "negative_prompt": "example",
      "outputHeight": 1,
      "outputWidth": 1,
      "path": "example",
      "prompt": "example",
      "quality": "example",
      "resolution_ratio": 1,
      "seed": 1,
      "size": 1,
      "status": 1,
      "style": "example",
      "url": "example"
    }
  }
}

List credit usage

List credit usage in PixVerse.

Inputs

Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.
Creation typecreation_typelist
Creation type.
Credits statuscredits_statustext
Credits status.One of: consume, refund.
Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "has_more": false,
      "items": [],
      "next_cursor": "example"
    }
  }
}

List effect templates

List effect templates in PixVerse.

Inputs

Typetypetext
Type.One of: 1, 2.
Template IDstemplate_idstext
Template IDs.
Pagepagenumber
Page.At least 1.
Page sizepage_sizenumber
Page size.One of: 10, 20, 50, 100.
Template modetemplate_modetext
Template mode.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "effect_items": []
    }
  }
}

List text-to-speech speakers

List text-to-speech speakers in PixVerse.

Inputs

Page numpage_numnumber
Page num.At least 0. Default: 1.
Page sizepage_sizenumber
Page size.One of: 0, 10, 20, 50, 100. Default: 20.
Speaker typespeaker_typetext
Speaker type.One of: system, custom, all. Default: all.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "data": [],
      "total": 1
    }
  }
}

List video styles

List video styles in PixVerse.

Inputs

Page numpage_numnumber
Page num.At least 1. Default: 1.
Page sizepage_sizenumber
Page size.At least 1. Default: 500.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "data": [],
      "total": 1
    }
  }
}

Restyle video

Restyle video in PixVerse.

Inputs

Source video idsource_video_idnumber
Source video id.At least 1.
Video media idvideo_media_idnumber
Video media id.At least 1.
Restylerestyle_idnumber
Restyle id.At least 1.
Restyle promptrestyle_prompttext
Restyle prompt.
Seedseednumber
Seed.From 0 to 2147483647.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Upload image

Upload image in PixVerse.

Inputs

Filefiletext
Choose a workflow file or enter its public link.
Image URLimage_urltext
Image URL.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "img_id": 1,
      "img_url": "example"
    }
  }
}

Upload video or audio

Upload video or audio in PixVerse.

Inputs

Filefiletext
Choose a workflow file or enter its public link.
File URLfile_urltext
File URL.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "height": 1,
      "media_id": 1,
      "media_type": "example",
      "url": "example",
      "width": 1
    }
  }
}

Upscale video

Upscale video in PixVerse.

Inputs

Source video IDsource_video_idnumber
Source video ID.At least 1.
Video media IDvideo_media_idnumber
Video media ID.At least 1.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {
      "credits": 1,
      "video_id": 1
    }
  }
}

Verify uploaded audio

Verify uploaded audio in PixVerse.

Inputs

Audio media IDaudio_media_idnumberRequired
Audio media ID.At least 1.

Outputs

dataobject
Response value.
Example output
{
  "data": {
    "ErrCode": 1,
    "ErrMsg": "example",
    "Error": {
      "Message": "example",
      "Param": {
        "AllowedValues": [],
        "Fields": [],
        "Moderation": {
          "LabelName": "example"
        },
        "RequiredCount": 1,
        "RequiredField": "example"
      },
      "Type": "example"
    },
    "Resp": {}
  }
}

On this page