Help Center/ KooDrive/ API Reference/ API/ File Management/ This API is used to generate a document thumbnail task.

Updated on 2026-03-18 GMT+08:00

View PDF

This API is used to generate a document thumbnail task.

Function

API for generating a document thumbnail task.

Authorization Information

No identity policy-based permission required for calling this API.

URI

POST /koodrive/ose/v1/document/thumbnail

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	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}.
X-Traceid	No	String	Message log trace ID. The value contains 58 bits.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
x-hw-share-folder-id	No	String	Definition: ID of the shared folder. If this request header is passed, the current operation is performed in the shared folder. Constraints: N/A Range: N/A Default Value N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
fileId	Yes	String	File ID.
userId	Yes	String	User ID.
containerId	Yes	String	Space ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
code	Integer	Response code.
msg	String	Response.

Example Requests

Request example of the API for generating a document thumbnail

/koodrive/ose/v1/document/thumbnail

Authorization:Bearer+10f88d07fa************44791e9ff
{
  "containerId": "IAAAKIRZGifzJgncA1605122035640590977",
  "fileId": "FkiferVNK5NwXck7XXBhPLIRhV1GayJPc",
"userId": "1605107117323346560"
}