Queries information about a PPT artifact.
Operation description
Usage notes:
- This API uses the HTTP Server-Sent Events (SSE) protocol.
- The OpenAPI portal is not compatible with the SSE protocol and cannot be used for direct debugging. For examples of how to call the API using an SDK for Java or Python, see PPT Generation Best practices.
- To obtain the latest version of the asynchronous Java SDK, download it from the API portal.
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:GetPptArtifact | get | *All Resource
| None | None |
Request syntax
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | No | The workspace ID. | llm-az2gglxxxx |
| PptArtifactId | integer | No | The ID of the PPT artifact. | 5232136 |
| ExternalUserId | string | No | abc |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The response schema. | ||
| RequestId | string | The ID of the request. | xxxxx |
| Success | boolean | Indicates whether the request was successful. | true |
| Code | string | The error code. | DataNotExists |
| Message | string | The error message. | Error message |
| HttpStatusCode | integer | The HTTP status code. | 400 |
| Data | object | The task response object. | |
| CreateTime | string | The time when the resource was last updated. | 2024-11-25 11:40:50 |
| Id | integer | The unique ID of the artifact. | 10 |
| Title | string | The title. | Content title |
| UpdateTime | string | The time when the artifact was last updated. | 2024-11-25 11:40:50 |
| FileKey | string | The storage path of the file in the backend. | oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx |
| FileAttr | object | The file properties. | |
| FileName | string | The file name. | xxx.pptx |
| Width | integer | The width. | 800 |
| TmpUrl | string | The temporary access URL for the file. The URL expires in one hour. | |
| Height | integer | The height. | 600 |
Examples
Success response
JSON format