Help Center/ KooDrive/ API Reference（Carrier）/ API/ Album Management/ Creating an Album
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Creating an Album

Function

Create an album.

URI

POST /koodrive/ose/v1/album/create

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication.

Constraints:

The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z.

Range:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

N/A

Default Value

If this parameter is not transferred, English (United States) is used by default.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Album name.

Constraints:

This parameter is mandatory for manual albums and optional for collection albums.

Range:

A string of 1 to 20 characters.

Default Value:

N/A

type

Yes

String

Definition:

Album type.

Constraints:

N/A

Range:

1: collection album 2: manual album

Default Value:

N/A

scopeDir

No

Array of strings

Definition:

Collection scope.

Constraints:

The scope-related fields are required when the album type is 1.

Range:

A maximum of 30 directory IDs are supported.

Default Value:

N/A

scopeParentFolderId

No

String

Definition:

Parent directory ID of the collection scope.

Constraints:

The scope-related fields are required when the album type is 1.

Range:

N/A

Default Value:

N/A

scopeKind

No

String

Definition:

Album type.

Constraints:

The scope-related fields are required when the album type is 1.

Range:

1: image 2: video Example: 1,2.

Default Value:

N/A

groupId

No

String

Definition:

ID of the associated shared group.

Constraints:

This parameter is required when album_kind is set to 2.

Range:

N/A

Default Value:

N/A

albumKind

Yes

String

Definition:

Album type.

Constraints:

N/A

Range:

1: personal album 2: shared album

Default Value:

N/A

shareFolderId

No

Long

Definition:

Primary key (family space ID) of the associated shared folder, which is not the folder ID.

Constraints:

This parameter is required when album_kind is set to 2.

Range:

N/A

Default Value:

N/A

containerId

No

String

Definition:

Space ID of the collection scope.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

albumId

String

Album ID.

Example Requests

Create an album.

/koodrive/ose/v1/album/create

{
  "name" : "albumName",
  "type" : 2,
  "albumKind" : 1
}

Example Responses

Status code: 200

Response to the request for creating an album.

{
  "albumId" : "1805929618625036417",
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

Response to the request for creating an album.
Parent topic: Album Management