SaveMaterialDocument-阿里云帮助中心

Save material: Save material to the Material Library.

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
aimiaobi:SaveMaterialDocument	create	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:SaveMaterialDocument

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentKey	string	Yes	Unique identifier for the workspace: AgentKey	c160c841c8e54295bf2f441432785944_p_efm
DocType	string	Yes	Document type (html: web page, plainText: plain text, image: image, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)	excel
Title	string	No	Document title	新闻标题
Author	string	No	Author	作者名称
PubTime	string	No	Publication time, format: yyyy-MM-dd HH:mm:ss	2023-04-11 06:14:07
DocKeywords	array	No	Document tags used for classification, etc.
	string	No	Keyword	关键词
Url	string	No	URL of the material	http://xxxxx/xxx
ExternalUrl	string	No	URL uploaded by external customers, used only for record keeping	http://xxxxx/xxx
SrcFrom	string	No	Document source (UserUpload: User Upload, IntellijSearch: Intelligent Search, HotViewPoint: Hot Viewpoint)	IntellijSearch
TextContent	string	No	Parsed text content, empty for images	文本内容
HtmlContent	string	No	Formatted content	网页内容
ShareAttr	integer	No	Sharing attribute: 0: private, 1: shared within the workspace	1
BothSavePrivateAndShare	boolean	No	Is the material saved to both the private library and the shared library?	false
Summary	string	No	Summary	摘要

Response elements

Element	Type	Description	Example
	object	PlainResult
Code	string	Status code	DataNotExists
Data	integer	Business data	12
HttpStatusCode	integer	HTTP status code	200
Message	string	Error description	数据不存在
RequestId	string	Unique request identifier	3f7045e099474ba28ceca1b4eb6d6e21
Success	boolean	Is successful: true for success, false for failure	false

Examples

Success response

JSON format

{
  "Code": "DataNotExists",
  "Data": 12,
  "HttpStatusCode": 200,
  "Message": "数据不存在",
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.