PixVerse Platform Docs
  1. Getting started
PixVerse Platform Docs
  • Learn about PixVerse Platform
    • Introduce to PixVerse Platform
    • Our latest version v5.5/v5.6!
    • Quick Start
  • Getting started
    • How does the API work?
    • How to get API key?
    • How to check account balance?
    • How to subscribe API plans?
    • How to use Text-to-video
    • How to use Image-to-video
    • How to use Effects?
    • How to use Image template?
    • How to use Transition(First-last frame Feature)
    • How to use Speech(Lip sync)?
    • Lip sync TTS speaker list
    • How to use Extend?
    • How to use Sound effects?
    • How to use Fusion(Reference to video)?
    • How to use Restyle?
    • How to use Multi-transition?
    • How to use Swap?
    • How to get video generation status?
    • How to use Webhook
  • API Reference
    • API Parameter Description
    • Video Generation
      • Text-to-Video generation
      • Image-to-Video generation
      • Transition(First-last frame) generation
      • Speech(Lipsync) generation
      • Get Speech(Lipsync) tts list
      • Fusion(reference to video) generation
      • Multi-transition video generation
      • Restyle video generation
      • Restyle effect list
      • Swap mask generation
      • Swap video generation
      • Sound effect generation
      • Extend generation
      • Get Video Generation Status
    • Image generation
      • Image template generation
      • Get Image generation
    • Upload Image
      POST
    • Upload Video&audio
      POST
    • Get user credit balance
      GET
  • Trouble Shooting
    • Common errors and Solutions
    • Error codes
    • FAQ
  • Resources
    • Model & Pricing
    • Rate limit
    • Support
    • Change Logs
    • Term of Service
    • Privacy policy
  • PixVerse Tools
    • PixVerse MCP
  • Schemas
    • Schemas
      • controller.ResponseData
      • controller.T2vCreateVideoGenerateTaskReq
      • dto.APIKeyCreateReq
      • dto.APIKeyDefaultResp
      • dto.APIKeyDetail
      • dto.APIKeyList
      • dto.AccountApi
      • dto.AccountCreditsAddReq
      • dto.AddCasbinUserRoleReq
      • dto.AddEffectReq
      • dto.AddRoleReq
      • dto.AddScoringRelationReq
      • dto.AdminAddMusicItem
      • dto.AdminAddMusicRequest
      • dto.AdminAddTemplateItem
      • dto.AdminAddTemplateRequest
      • dto.AdminAddTemplateResponse
      • dto.AdminAddWebTemplateItem
      • dto.AdminAddWebTemplateRequest
      • dto.AdminAddWebTemplateResponse
      • dto.AdminAllUsersResp
      • dto.AdminAppFeedDetail
      • dto.AdminAppListAllFeedsReq
      • dto.AdminAppListAllFeedsResp
      • dto.AdminAppListAllVideosReq
      • dto.AdminAppListAllVideosResp
      • dto.AdminAppVideoDetail
      • dto.AdminFeedsGetFeaturePoolReq
      • dto.AdminFeedsSetFeaturePoolReq
      • dto.AdminGetMusicItem
      • dto.AdminGetMusicRequest
      • dto.AdminGetMusicResponse
      • dto.AdminTemplateListItem
      • dto.AdminTemplateListResponse
      • dto.AdminUpdateMusicRequest
      • dto.AdminUpdateTemplateRequest
      • dto.AdminUpdateWebTemplateRequest
      • dto.AdminUpdateWebTemplateResponse
      • dto.AdminVideos
      • dto.AdminWebTemplateListItem
      • dto.AdminWebTemplateListRequest
      • dto.AdminWebTemplateListResponse
      • dto.AllAdminVideosReq
      • dto.AllAdminVideosResp
      • dto.AppAddTemplateItem
      • dto.AppAddTemplateRequest
      • dto.AppAddTemplateResponse
      • dto.AppCommentCountsRequest
      • dto.AppCommentCountsResponse
      • dto.AppCommentDeleteRequest
      • dto.AppCommentDeleteResponse
      • dto.AppCommentItem
      • dto.AppCommentListRequest
      • dto.AppCommentListResponse
      • dto.AppCommentRequest
      • dto.AppCommentResponse
      • dto.AppExtendReq
      • dto.AppI2VReq
      • dto.AppLikeCountsRequest
      • dto.AppLikeCountsResponse
      • dto.AppLikeDeleteRequest
      • dto.AppLikeDeleteResponse
      • dto.AppLikeRequest
      • dto.AppLikeResponse
      • dto.AppMusicAllListRequest
      • dto.AppMusicAllListResponse
      • dto.AppMusicDetailRequest
      • dto.AppMusicDetailResponse
      • dto.AppMusicRecommendRequest
      • dto.AppMusicRecommendResponse
      • dto.AppMusicTrendingListRequest
      • dto.AppMusicTrendingListResponse
      • dto.AppPublicVideoReq
      • dto.AppPublicVideoResp
      • dto.AppPurchaseReq
      • dto.AppPurchaseResp
      • dto.AppReportRequest
      • dto.AppReportResponse
      • dto.AppRetryVideoReq
      • dto.AppT2VReq
      • dto.AppTemplateDetailListFeedItem
      • dto.AppTemplateDetailListRequest
      • dto.AppTemplateDetailListResponse
      • dto.AppTemplateDetailRequest
      • dto.AppTemplateDetailResponse
      • dto.AppTemplateListItem
      • dto.AppTemplateListRequest
      • dto.AppTemplateListResponse
      • dto.AppUpdateTemplateRequest
      • dto.AppVideoCallbackInfo
      • dto.AppVideoCallbackReq
      • dto.AppVideoCreateReq
      • dto.AppVideoCreateResp
      • dto.AppVideoDetail
      • dto.AppVideoListReq
      • dto.AppVideoListResp
      • dto.AppWebDeleteVideoReq
      • dto.AppWebVideoDetailReq
      • dto.AppWebVideoResp
      • dto.AppleLoginReq
      • dto.AppleLoginResp
      • dto.ApplePayVerifyReceiptReq
      • dto.AssetCreateReq
      • dto.AssetCreateResp
      • dto.AssetDeleteResp
      • dto.Audit
      • dto.AvatarDeleteRequest
      • dto.AvatarDeleteResponse
      • dto.AvatarDetailItem
      • dto.AvatarGenerateMediaRequest
      • dto.AvatarGenerateMediaResponse
      • dto.AvatarItem
      • dto.AvatarMaterialItem
      • dto.AvatarMediaItem
      • dto.AvatarPreviewVoiceRequest
      • dto.AvatarUpdateRequest
      • dto.AvatarUpdateResponse
      • dto.AvatarWhiteListIsExist
      • dto.BatchUploadMediaReq
      • dto.BatchUploadMediaResp
      • dto.BetaTesterMemberReq
      • dto.BetaTesterMemberResp
      • dto.BlockAccountReq
      • dto.BusinessEffectListItem
      • dto.BusinessEffectSelectResponse
      • dto.CallbackInfo
      • dto.CheckAccountRoleReq
      • dto.CheckAccountRoleResp
      • dto.CommonData
      • dto.CorporateReq
      • dto.CreateCateReq
      • dto.CreateCateResp
      • dto.CreateImg2VideoGenerateTaskReq
      • dto.CreateImgGenerateTaskReq
      • dto.CreateLabelingJobReq
      • dto.CreateLabelingJobResp
      • dto.CreateTxt2VideoGenerateTaskReq
      • dto.CreateVideo2VideoGenerateTaskReq
      • dto.CreditsPurchaseResp
      • dto.DeleteAccountReq
      • dto.DeleteCategoryReq
      • dto.DeleteEffectReq
      • dto.DeleteFeedsReq
      • dto.DeleteLabelingJobReq
      • dto.DeleteLabelingJobResp
      • dto.DeleteMediaReq
      • dto.DeviceTokenReq
      • dto.DiscordCallbackReq
      • dto.DiscordImg2VideoReq
      • dto.DiscordLoginReq
      • dto.DiscordLoginResp
      • dto.DiscordTxt2VideoReq
      • dto.DislikeMediaReq
      • dto.EditMediaReq
      • dto.ExportLabelingJobReq
      • dto.ExportLabelingJobResp
      • dto.ExportMediaScoreReq
      • dto.ExportMediaScoreResp
      • dto.ExportMediaVideoReq
      • dto.ExportMediaVideoResp
      • dto.FeConfigs
      • dto.FeConfigsReq
      • dto.FeedCreateReq
      • dto.FeedDataResp
      • dto.FeiShuAuthReq
      • dto.FeiShuAuthResp
      • dto.FeiShuLoginReq
      • dto.FeiShuLoginResp
      • dto.FirebasePushReq
      • dto.GetAccountMediaHistoryReq
      • dto.GetAccountMediaHistoryResp
      • dto.GetAdminAllUsersResp
      • dto.GetAdminUserInfoResp
      • dto.GetAllJobsReq
      • dto.GetAllJobsResp
      • dto.GetAllMediasReq
      • dto.GetAllUmodelsReq
      • dto.GetAllUmodelsResp
      • dto.GetAllVersionsReq
      • dto.GetAllVersionsResp
      • dto.GetAllVideoModelsResp
      • dto.GetAllVideoUmodelsReq
      • dto.GetAllVideoUmodelsResp
      • dto.GetAllVideosReq
      • dto.GetAuditResultReq
      • dto.GetAuditResultResp
      • dto.GetAvatarDetailResponse
      • dto.GetAvatarListResponse
      • dto.GetAvatarOrMaterialOrMediaDetailRequest
      • dto.GetAvatarOrMaterialOrMediaLibraryListRequest
      • dto.GetAvatarOrMaterialOrMediaListRequest
      • dto.GetCategoryIdByNameReq
      • dto.GetCategoryIdByNameResp
      • dto.GetFeCfgReq
      • dto.GetFeCfgResp
      • dto.GetFeConfigsReq
      • dto.GetFeConfigsResp
      • dto.GetGenerateCreditsRequest
      • dto.GetGenerateCreditsResponse
      • dto.GetLikedVideoReq
      • dto.GetMediaDetailReq
      • dto.GetMediaDetailResp
      • dto.GetMembersInfoReq
      • dto.GetMusicItem
      • dto.GetOpenAPICreditsRecordReq
      • dto.GetOpenAPICreditsRecordV2Req
      • dto.GetOpenapiMediaDetailResp
      • dto.GetPhoneCodeReq
      • dto.GetTasksByJobIdReq
      • dto.GetTasksByJobIdResp
      • dto.GetTraceLogByTraceIdReq
      • dto.GetTraceLogByTraceIdResp
      • dto.GetUploadTokenResp
      • dto.GetUserCreditsByIDResp
      • dto.GetUserCreditsRecordItem
      • dto.GetUserCreditsRecordReq
      • dto.GetUserCreditsRecordResp
      • dto.GetUserCreditsResp
      • dto.GetUserInfoByTokenResp
      • dto.GetV3AccountMediaHistoryReq
      • dto.GetV3AccountMediaHistoryResp
      • dto.GetV3AllVideosResp
      • dto.GetV3LikedVideoReq
      • dto.GetV3VideoDetailReq
      • dto.GetVideoDetailByDiscordCmdIdReq
      • dto.GetVideoLastFrameReq
      • dto.GetVideoLastFrameResp
      • dto.GetVideoTTSListResp
      • dto.GoogleLoginResp
      • dto.GooglePayVerifyReq
      • dto.Img2VideoDebugReq
      • dto.Img2VideoDebugResp
      • dto.IndividualReq
      • dto.LabelingJobApi
      • dto.LabelingTaskApiWithStatus
      • dto.LikeMediaReq
      • dto.LipSync
      • dto.ListVisionaries
      • dto.ListWebAppVideoReq
      • dto.ListWebVideos
      • dto.LoginPhoneWithCodeReq
      • dto.LoginPhoneWithCodeResp
      • dto.LoginPhoneWithPasswordReq
      • dto.LoginPhoneWithPasswordResp
      • dto.LoginReq
      • dto.LoginResp
      • dto.LoraCheckMediaReq
      • dto.MaterialDetailItem
      • dto.MediaDetailItem
      • dto.MembersChangeReq
      • dto.MembersChangeResp
      • dto.MembersPlanDetailsResp
      • dto.MembersProductsReq
      • dto.MembersProductsResp
      • dto.MessagePushReq
      • dto.MotionBrushSegmentationReq
      • dto.MotionBrushSegmentationResp
      • dto.NewGoogleLoginReq
      • dto.OpenAPIAccountBenefitsBalanceResp
      • dto.OpenAPICreditsRecordItem
      • dto.OpenAPICreditsRecordResp
      • dto.OpenAPIGetAccountInfoResp
      • dto.OpenAPIListOrdersReq
      • dto.OpenAPIListProductsReq
      • dto.OpenAPIListProductsResp
      • dto.OpenAPILoginReq
      • dto.OpenAPILoginResp
      • dto.OpenAPIMembersChangeResp
      • dto.OpenAPIOrderDetailsReq
      • dto.OpenAPIOrdersDetailsResp
      • dto.OpenAPIPlanDetailsReq
      • dto.OpenAPIPlanDetailsResp
      • dto.OpenAPIPurchaseReq
      • dto.OpenAPIPurchaseResp
      • dto.OpenAPIT2VReq
      • dto.OpenAPIT2VResp
      • dto.OpenAPIUnsubscribeReq
      • dto.OpenAPIV2CreditsRecordItem
      • dto.OpenAPIV2CreditsRecordResp
      • dto.OpenAPIWithdrawUnsubscribeReq
      • dto.OpenAPIit2vReq
      • dto.OrdersDetailsReq
      • dto.OrdersDetailsResp
      • dto.OrdersListResp
      • dto.PaymentConfirmReq
      • dto.PaymentConfirmResp
      • dto.QueryAccountReq
      • dto.RegisterAccountReq
      • dto.RegisterWithPhoneReq
      • dto.RegisterWithPhoneResp
      • dto.RemoveMediaReq
      • dto.ResetPasswordAccountReq
      • dto.ResetPasswordAccountResponse
      • dto.ResponseData500
      • dto.SearchCategoriesReq
      • dto.SearchCategoriesResp
      • dto.SearchMediasReq
      • dto.SearchMediasResp
      • dto.SendMailReq
      • dto.ShowCaseVideoVideo
      • dto.SockPuppetAddRequest
      • dto.SockPuppetAddResponse
      • dto.SubmitAvatarOrMaterialReq
      • dto.SubmitAvatarOrMaterialResponse
      • dto.SubmitJobReq
      • dto.SubmitJobResp
      • dto.SubmitTasksReq
      • dto.SubmitTasksResp
      • dto.TTS
      • dto.TensorSet
      • dto.Txt2ImgReq
      • dto.Txt2ImgResp
      • dto.UmodelApi
      • dto.UpdateAccountInfoReq
      • dto.UploadFileReq
      • dto.UploadFileResp
      • dto.UploadImageReq
      • dto.UploadImageResp
      • dto.UploadImgResp
      • dto.UploadMediaReq
      • dto.UploadMediaResp
      • dto.UserPermissions
      • dto.V2OpenAPII2VReq
      • dto.V2OpenAPII2VResp
      • dto.V2OpenAPIT2VReq
      • dto.V2OpenAPIT2VResp
      • dto.VideoDebugReq
      • dto.VideoDebugResp
      • dto.VideoDeleteReq
      • dto.VideoModelInfo
      • dto.VideoResp
      • dto.VideoUpscaleReq
      • dto.VisionaryCallbackInfo
      • dto.VisionaryCallbackReq
      • dto.VisionaryCreateReq
      • dto.VisionaryCreateResp
      • dto.VisionaryDetailReq
      • dto.VisionaryDetailResp
      • dto.VisionaryListReq
      • dto.VisionaryListResp
      • dto.WaitlistReq
      • dto.WebDeleteVideoReq
      • dto.WebExtendVideoReq
      • dto.WebExtendVideoResp
      • dto.WebF2VReq
      • dto.WebF2VResp
      • dto.WebTemplateListItem
      • dto.WebTemplateListReq
      • dto.WebTemplateListResponse
      • dto.WebVideoCallbackInfo
      • dto.WebVideoCallbackReq
      • dto.WebVideoCreateReq
      • dto.WebVideoCreateResp
      • dto.WebVideoListReq
      • dto.WebVideoListResp
      • model.AppleLoginApi
      • model.AssetData
      • model.AssetDetailOrDeleteReq
      • model.AssetImg
      • model.AssetListReq
      • model.AssetListResp
      • model.ClipInfo
      • model.DiscordLoginApi
      • model.FeishuLoginApi
      • model.GoogleLoginApi
      • model.LoginApi
  1. Getting started

How to get video generation status?

Overview#

Through this API, you can obtain detailed information about the video generation process, including processing status, video URL (if completed), and other metadata.
Endpoint: GET https://app-api.pixverse.ai/openapi/v2/video/result/{video_id}

Prerequisites#

Before you begin, make sure you have:
A valid PixVerse API key
A different Ai-trace-id for each unique request
A video_id from generation tasks

1. Prepare video_id from generation task#

After submitting a video generation request, you'll receive a video_id.

2. Get video generation status for Status Checking#

Use this video_id to periodically check the status of your generation:
Status code:
1 : Generation successful
5 : Waiting for generation
7 : Content moderation failure
8 : Generation failed
When the video is in processing status (status=5), it's recommended to poll at intervals of 3~5 seconds.

3. Result Retrieval#

Once processing is complete, the status endpoint will return status 1, indicating the video is ready. At this point, you can use the url field in the response to download or display the generated video.
  "ErrCode": 0,
  "ErrMsg": "",
  "Resp": {
    "create_time": "2025-03-25T08:30:00Z",
    "id": 12345,
    "modify_time": "2025-03-25T08:35:12Z",
    "negative_prompt": "blurry, low quality",
    "outputHeight": 720,
    "outputWidth": 1280,
    "prompt": "City sunset timelapse",
    "resolution_ratio": 0,
    "seed": 42,
    "size": 8427520,
    "status": 1,
    "style": "anime",
    "url": ""
  }
}

Recommended Practices#

1.
Polling Interval: When the video is in processing status (status=5), it's recommended to poll at intervals of no less than 5 seconds (3~5 seconds)
2.
Save video&video_id : video_id is the unique identifier for querying status.
Previous
How to use Swap?
Next
How to use Webhook