Response

After submitting a long video via the POST /project/create endpoint, you will receive a JSON response containing the status of the request and important information for retrieving the generated clips.

Response Format

{
  "code": 2000,
  "projectId": 17861706,
  "shareLink": "https://vizard.ai/project?invite=BW77vF&susId=1862&utm_source=project_share&utm_medium=project_share_email&utm_campaign=project_share_email",
  "errMsg": ""
}

Response Fields

FieldTypeDescription
codeintStatus code of the request. See details in the status code table.
projectIdstringUnique ID of the project. Used to poll or retrieve clips.
shareLinkstringShareable link to the project (only available for Business/Team plan users).
errMsgstringError message, shown only when code is not 2000.

Status Code Reference

CodeMeaning
2000

The request is valid, and the project is being created.

Please note that a return code of 2000 doesn’t necessarily mean the project was successfully created. In some cases — for example, when a valid Google Drive URL is provided but Google returns an access error — the project may fail to be created even though the request was accepted.

To verify whether the project was actually created, please use the query endpoint.
https://docs.vizard.ai/docs/retrieve-video-clips

4001Invalid API key.
4002Project creation failed.
4003Rate limit exceeded.
4004Unsupported video format.
4005The video file is broken.
4006Illegal parameter.
4007Insufficient remaining minutes.
4008Can not download video file from the url specified in request.
4009The video URL specified in request is invalid.
4010Can not detect the spoken language in video.
Try changing the language parameter from auto to a specific language code.

What’s Next

Use the projectId returned in this response to retrieve the clips.

Did this page help you?