AsyncUploadVideo

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	Access level	Resource type	Condition key	Dependent action
aimiaobi:AsyncUploadVideo	create	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:AsyncUploadVideo

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
SourceVideos	array<object>	Yes	The structure of the video editing materials.
	object	No	The structure of the video editing materials.
VideoName	string	Yes	The name of the video.	123.mp4
VideoUrl	string	Yes	The URL of the video.	http://123.mp4 Currently, this API only performs video understanding and analysis and does not transfer files. Ensure that the video URL remains valid during task execution.
VideoExtraInfo	string	No	Additional description of the video.	There is a house in the video.
AnlysisPrompt	string	No	The prompt for video understanding.	Focus on understanding the scenery information in the video.
WorkspaceId	string	Yes	The ID of the Alibaba Cloud Model Studio workspace.	llm-xxxx
ReferenceVideo	object	No	Information about the reference video.
VideoName	string	No	The name of the reference video.	refvideo.mp4
VideoUrl	string	No	The URL of the video.	http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/d71e_208334498220521996_51298e0a909d457693166eb883768c7a
VideoExtraInfo	string	No	Additional information for video understanding.	The phone CPU uses 3-nanometer technology.
SplitInterval	integer	No	The time interval for video understanding shots.	1
VideoRoles	array<object>	No	Face information of the roles.
	array<object>	No	The name of the role.
RoleName	string	No	The name of the role.	Li Xiaoming
RoleInfo	string	No	Information about the role.	Li Xiaoming is a police officer.
RoleUrls	array<object>	No	The URLs of the role photos.
	object	No	Information about the role's image file.
RoleFileName	string	No	The file name of the role's facial image.	Wang Xiaoming.jpeg
RoleFileUrl	string	No	The public URL of the role's facial image.	http://xxx/xxx.jpeg
FaceIdentitySimilarityMinScore	number	No	The similarity threshold for character recognition.	0.7
VideoShotFaceIdentityCount	integer	No	The number of frames sampled from a single shot for character matching.	2
RemoveSubtitle	boolean	No	Removes captions from the material.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	94512A33-8EC1-5452-A793-5C91F18ED2F0
Code	string	The status code returned for the request.	successful
Data	object	The business data.
TaskId	string	The task ID.	3f7045e099474ba28ceca1b4eb6d6e21
VideoInfos	array<object>	Information about the videos.
	object	Information about the video.
VideoId	string	The video ID.	60616fad41b171f0bb4b4531948c0102
VideoName	string	The name of the video.	123.mp4
VideoUrl	string	The video URL.	http://123.mp4
VideoExtraInfo	string	Additional information about the video.	There is a house in the video.
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message.	success
Success	boolean	Indicates whether the request was successful. `true` indicates success. `false` indicates failure.	true

Examples

Success response JSON format

{
  "RequestId": "94512A33-8EC1-5452-A793-5C91F18ED2F0",
  "Code": "successful",
  "Data": {
    "TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "VideoInfos": [
      {
        "VideoId": "60616fad41b171f0bb4b4531948c0102",
        "VideoName": "123.mp4",
        "VideoUrl": "http://123.mp4",
        "VideoExtraInfo": "There is a house in the video."
      }
    ]
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	You are not authorized to perform this action.	Please check the workspaceId assignment

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes