ListLumaChunks - EventBridge - Alibaba Cloud Documentation Center

Lists text chunks in a knowledge base bound to a Luma Agent, with support for filtering by document, keyword, and enabled status.

Operation description

Lists text chunks in a knowledge base bound to a Luma Agent, with support for filtering by document, keyword, and enabled status.

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.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AgentName	string	Yes	The name of the agent.	my_agent
Catalog	string	Yes	The name of the data catalog bound to the agent. You can call ListLumaCatalogs to obtain this value.	my_catalog
Namespace	string	Yes	The name of the namespace bound to the agent. You can call ListLumaNamespaces to obtain this value.	my_namespace
KnowledgeBaseName	string	Yes	The name of the knowledge base bound to the agent. You can call ListLumaKnowledgeBases to obtain this value.	my-knowledge-base
DocumentId	string	No	The ID of the document used to filter text chunks. If this parameter is not specified, text chunks of all documents in the knowledge base are returned.	doc-a1b2c3d4
Keyword	string	No	The keyword used to filter text chunks by content.	Event rule
Enabled	boolean	No	Specifies whether to return only enabled text chunks. If this parameter is not specified, text chunks are not filtered by enabled status.	true
MaxResults	integer	No	The maximum number of records to return. Valid values: 1 to 100. If this parameter is not specified, the server uses a default value.	20
NextToken	string	No	The pagination token. Do not specify this parameter for the first request. For subsequent requests, use the NextToken value returned in the previous response. This value is an opaque string. Do not parse it.	ca1eb85f5d99c7d6a97e6****

Response elements

Element	Type	Description	Example
	object
Message	string	The message returned by the operation. The value is Operation success if the call succeeds, or a specific error description if the call fails.	Operation success
RequestId	string	The unique ID of the request. Use this ID for troubleshooting and when submitting a ticket.	34AD682D-5B91-5773-8132-AA38C130****
Data	object	The chunk list result, which contains chunk entries and pagination information.
Chunks	array	The list of chunk entries.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","ChunkSeq":1}]
	KnowledgeBaseChunk	The details of a single chunk, including the chunk sequence number, body, title path, and enabled status.
NextToken	string	The pagination token for the next page (an opaque string). Pass this value as the NextToken parameter in the next request to retrieve the next page. An empty value indicates that no more data is available.	ca1eb85f5d99c7d6a97e6****
TotalCount	integer	The total number of chunks in the document.	120
Code	string	The response code. A value of Success indicates that the call succeeded. If the call fails, a specific error code is returned.	Success
Success	boolean	Indicates whether the call is successful. A value of true indicates success.	true

Examples

Success response

JSON format

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Data": {
    "Chunks": [
      {
        "ChunkSeq": 12,
        "ChunkSize": 128,
        "Content": "EventBridge supports routing events to multiple target services",
        "CreatedAt": "2026-08-24T10:00:00Z",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "Enabled": true,
        "FileName": "product-handbook.pdf",
        "SourceLocation": "p.3",
        "TitlePath": "Installation Guide>Prerequisites",
        "UpdatedAt": "2026-08-24T10:00:00Z"
      }
    ],
    "NextToken": "ca1eb85f5d99c7d6a97e6****",
    "TotalCount": 120
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter is invalid
403	ServiceNotEnable	Service not enable
404	AgentNotFound	Agent not found
404	ResourceNotFound	The specified resource is not bound to the agent

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.