Help Center/ MetaStudio/ API Reference/ Asset Management/ File Management/ Creating a File and Obtaining the URL for File Upload

Updated on 2024-07-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating a File and Obtaining the URL for File Upload

Function

You can create a file and obtain the URL for file upload.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/files

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'.
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
file_name	Yes	String	File name, which is case-insensitive. The value can contain 1 to 256 characters.
file_md5	Yes	String	MD5 value of the file content. The MD5 value must be encoded using Base64. An encoded string is for 24 bytes.
file_size	Yes	Long	Total file size. The value ranges from 1 to 5368709120.
file_type	Yes	String	File type (the file name extension is extracted by default).
asset_id	Yes	String	Asset ID.
asset_file_category	Yes	String	File category in an asset. Each type of asset has different file categories. MAIN: main file COVER: thumbnail file PAGE: image file of the PPT content page SAMPLE: sample audio or action file OTHER: other files WHOLE_MODEL: full model file (3D virtual human) USER_MODIFIED_MODEL: model uploaded by a user (3D virtual human) NOTE: When the asset type is SCENE, ANIMATION, VIDEO, IMAGE, or MATERIAL, categories are MAIN, COVER, and OTHER. When the asset type is PPT, categories are MAIN, COVER, PAGE, and OTHER. When the asset type is HUMAN_MODEL, categories are MAIN, COVER, WHOLE_MODEL, USER_MODIFIED_MODEL and OTHER. When the asset type is VOICE_MODEL, categories are MAIN, SAMPLE (sample audio file), and OTHER. When the asset type is HUMAN_MODEL_2D, categories are MAIN, COVER, SAMPLE (sample action), and OTHER. When the asset type is BUSINESS_CARD_TEMPLET, categories are MAIN and COVER (business card demo). When the asset type is IMAGE, category is MAIN. When the asset type is VIDEO, categories are MAIN, and COVER.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
file_id	String	File ID.
upload_url	String	URL for file upload. The validity period is 24 hours. NOTE: Call the OBS API Uploading an Object - PUT to upload a file.] When calling the preceding API, specify the Content-MD5 header. The value must be the same as that in file_md5.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/files

{
  "file_name" : "1.png",
  "file_md5" : "n58IG6hfM7vqI4K0vnWpog==",
  "file_size" : 1048576,
  "file_type" : "png",
  "asset_id" : "8cb2f48a2cb006154794741933421100",
  "asset_file_category" : "MAIN"
}

Example Responses

Status code: 200

Successful.

{
  "file_id" : "b2f8a9e9c39b6dc7ed4c0cfd67366c6a",
  "upload_url" : "https://{endpoint}:443/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671154644&Signature=vXxiJTO239WZcG8sniotTe9qOc4%3D"
}

Status code: 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 401

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code	Description
200	Successful.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
500	Internal service error.