PreviewDocument

Operation description

Prerequisites

You must activate Alibaba Cloud Model Studio and Tongyi Gold services.
Obtain the workspace ID. For more information, see workspace identity.

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
dianjin:PreviewDocument	get	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

dianjin:PreviewDocument

get

*All Resource

*

None

Request syntax

GET /{workspaceId}/api/library/document/preview HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	Path parameter, workspace ID.	llm-xxxxx

Request parameters

Parameter	Type	Required	Description	Example
documentId	string	Yes	Document ID.	8326472354762354

Response elements

Element	Type	Description	Example
	object	ResultCode
cost	integer	Time consumed.	null
data	object	Returned data.
previewType	string	Preview type.	pdf
title	string	Document title.	test
uploadTime	string	Upload time.	2024-01-01 00:00:00
url	string	Document URL.	https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png
dataType	string	Data type.	null
errCode	string	Error code.	0
message	string	Error message.	ok
requestId	string	Request ID.	ff551395-1c8a-4f30-8ffd-ef7e87c70b4c
success	boolean	Is successful.	true
time	string	Time.	2024-04-24 11:54:34

Examples

Success response JSON format

{
  "cost": 0,
  "data": {
    "previewType": "pdf",
    "title": "test",
    "uploadTime": "2024-01-01 00:00:00",
    "url": "https://agi.alicdn.com/user/d0o/d3c1f50d-a6c2-49b3-b0c8-3e613c3f20ee_16872_3236784461.png"
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "ff551395-1c8a-4f30-8ffd-ef7e87c70b4c",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Operation description

​Try it now

​RAM authorization

​Request syntax

​Path Parameters

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes