GetMaterialById-Alibaba Cloud Model Studio(Model Studio)-阿里云帮助中心

Retrieves detailed information about a material from 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:GetMaterialById	get	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:GetMaterialById

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AgentKey	string	Yes	Unique identifier of the workspace: AgentKey	67c520d1fa43455ea44fb69fa402d54d_p_beebot_public
Id	integer	Yes	Primary key ID of the task	60

Response elements

Element	Type	Description	Example
	object	PlainResult<materialdocumentdo>
Code	string	Status code	DataNotExists
Data	object	Business data
Author	string	Author	Document author
CreateTime	string	Creation time	2023-03-21 11:34:19
CreateUser	string	Creator user ID	1
DocKeywords	array	Document tags used for classification and other purposes. Separate multiple keywords with commas.
	string	Keyword	Keyword
DocType	string	Document type, such as pdf, word, url, or image	pdf
ExternalUrl	string	URL uploaded by an external customer. Used only for record keeping.	https://www.example.com
HtmlContent	string	Web page content	Web page content
Id	integer	Primary key	32
PubTime	string	Publication time	2023-04-11 06:14:07
PublicUrl	string	Temporary public URL	https://www.example.com
ShareAttr	integer	Sharing attribute stored as bit flags. The first bit indicates sharing within the workspace, the second bit indicates sharing within the tenant, and the third bit indicates system-wide sharing.	1
SrcFrom	string	Document source, such as user_upload, search, or viewpoint	user_upload
Summary	string	Document summary	Document summary
TextContent	string	Parsed text content. Empty for images.	Text content
ThumbnailInBase64	string	Base64-encoded thumbnail for image documents	Base64-encoded thumbnail
Title	string	Document title	Document title
UpdateTime	string	Modification time	2022-04-08 19:33:01
UpdateUser	string	Modifier user ID	1
Url	string	Internal document storage URL	https://www.example.com
HttpStatusCode	integer	HTTP status code	200
Message	string	Error description	Data does not exist
RequestId	string	Unique request identifier	3f7045e099474ba28ceca1b4eb6d6e21
Success	boolean	Indicates success: true for success, false for failure	false

Examples

Success response

JSON format

{
  "Code": "DataNotExists",
  "Data": {
    "Author": "Document author",
    "CreateTime": "2023-03-21 11:34:19",
    "CreateUser": "1",
    "DocKeywords": [
      "Keyword"
    ],
    "DocType": "pdf",
    "ExternalUrl": "https://www.example.com\n",
    "HtmlContent": "Web page content",
    "Id": 32,
    "PubTime": "2023-04-11 06:14:07\n",
    "PublicUrl": "https://www.example.com\n",
    "ShareAttr": 1,
    "SrcFrom": "user_upload",
    "Summary": "Document summary",
    "TextContent": "Text content",
    "ThumbnailInBase64": "Base64-encoded thumbnail",
    "Title": "Document title",
    "UpdateTime": "2022-04-08 19:33:01",
    "UpdateUser": "1",
    "Url": "https://www.example.com"
  },
  "HttpStatusCode": 200,
  "Message": "Data does not exist",
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.