Retrieves information about a document.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- 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:GetDocInfo | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The unique identifier of the workspace in Alibaba Cloud Model Studio. For instructions on how to obtain a workspace ID, see Obtain a Workspace ID. | llm-xxx |
| DocId | string | Yes | The document ID. | 12345 |
| CategoryId | string | No | The category where the document is stored. | default |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The schema of the response. | ||
| Code | string | The internal error code. | successful |
| Data | object | The response data. | |
| DocName | string | The document name. | Television Broadcasts 2020 Annual Report |
| DocType | string | The document type. | |
| FileUrl | string | The URL of the document. | http://xxx/xxx.pdf |
| Status | integer | The task status. | 1 and 0. A status of 1 indicates that the document was retrieved successfully, and the user can perform operations such as generating a document summary or a mind map. |
| StatusMessage | string | The status message. | Import successful |
| VideoContents | array | Text transcripts from the video's audio. | |
string | A text transcript from the video's audio. | Text content | |
| CategoryId | string | The category where the document is stored. | default |
| PageInfo | object | ||
| Width | integer | 100 | |
| Height | integer | 200 | |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| Message | string | The response message. | successful |
| RequestId | string | The request ID. | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Indicates whether the request was successful. A value of | true |
Examples
Success response
JSON format
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 |