Retrieve a list of documents: Query the history of articles created in MiaoBi.
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:ListGeneratedContents | list | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | Workspace ID: AgentKey | xxxxx_p_efm |
| TaskId | string | No | Task ID You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId for multiple tasks, those tasks belong to the same conversation. | task-03d46184ee7d8749 |
| StartTime | string | No | Start time | 2024-01-04 11:46:07 |
| EndTime | string | No | End time | 2024-01-04 11:46:07 |
| Title | string | No | Title text | Hangzhou Asian Games |
| Query | string | No | Search keyword: Supports fuzzy search on titles and content | Search Query |
| ContentDomain | string | No | Content domain (content category)
Valid values:
| media |
| Current | integer | No | Page number | 1 |
| Size | integer | No | Items per page. Default is 10. | 10 |
| DataType | string | No | Data type filter
| plainText |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Response | ||
| Code | string | Status code | NoData |
| Current | integer | Page number | 1 |
| Data | array<object> | Document list | |
array<object> | Document | ||
| Content | string | Content: rich text | Hangzhou Asian Games |
| ContentDomain | string | Content domain (content category)
| media |
| ContentText | string | Content: plain text | Hangzhou Asian Games |
| CreateTime | string | Creation time | 2024-01-04 11:46:07 |
| CreateUser | string | Creator | "123" |
| DeviceId | string | Device ID | xxx |
| Id | integer | Document ID | 10 |
| KeywordList | array | Keywords | |
string | Keyword | Opinion | |
| Keywords | string | Keywords (string) | Opinion |
| Prompt | string | Last prompt used to generate this document | Write xxx article |
| TaskId | string | Conversation task ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| Title | string | Title | Hangzhou Asian Games |
| UpdateTime | string | Update time | 2024-01-04 11:46:07 |
| UpdateUser | string | Updater | "1111" |
| Uuid | string | UUID traceability ID | xxx |
| FileKey | string | File ID | oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx |
| FileAttr | object | File attributes | |
| FileName | string | File name | homedepothp.txt |
| Width | integer | Video width | 800 |
| TmpUrl | string | Temporary URL for video file access. Expires in one hour. | |
| Height | integer | Video height | 500 |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Error message | success |
| RequestId | string | Request ID | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Size | integer | Number of items per page | 10 |
| Success | boolean | Operation status: true means success. false means failure. | true |
| Total | integer | Total number of items | 100 |
Examples
Success response
JSON format