ListLumaDocuments - EventBridge - Alibaba Cloud Documentation Center

Operation description

Lists documents in a knowledge base bound to a Luma Agent, with support for filtering by file name prefix and processing 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 the catalog name.	my_catalog
Namespace	string	Yes	The name of the namespace bound to the agent. You can call ListLumaNamespaces to obtain the namespace name.	my_namespace
KnowledgeBaseName	string	Yes	The name of the knowledge base bound to the agent. You can call ListLumaKnowledgeBases to obtain the knowledge base name.	my-knowledge-base
FileNamePrefix	string	No	The file name prefix used to filter documents.	manual-
Status	string	No	The processing status used to filter documents. Valid values: Pending, Processing, Ready, and Failed.	Ready
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. You can use this ID for troubleshooting and when you submit a ticket.	34AD682D-5B91-5773-8132-AA38C130****
Data	object	The document list result, which contains document entries and pagination information.
Documents	array	The list of document entries.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","FileName":"manual.pdf","Status":"COMPLETED"}]
	KnowledgeBaseDocument	The details of a document, including the file name, processing status, size, and number of chunks.
NextToken	string	The pagination token for the next page. This is 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 documents that match the filter conditions.	10
Code	string	The response code. A value of Success indicates that the call succeeds. If the call fails, a specific error code is returned.	Success
Success	boolean	Indicates whether the call is successful. A value of true indicates that the call succeeds.	true

Examples

Success response

JSON format

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Data": {
    "Documents": [
      {
        "ChunkConfiguration": {
          "HeadingLevel": 2,
          "MaxChunkSize": 600,
          "OverlapSize": 40,
          "PreprocessRules": {
            "RemoveUrlsAndEmails": false,
            "ReplaceConsecutiveWhitespace": true
          },
          "Separator": "\\\\n\\\\n",
          "Strategy": "BY_SEPARATOR"
        },
        "ChunkCount": 120,
        "CreatedAt": "2026-08-24T10:00:00Z",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "ErrorCode": "FILE_CORRUPTED",
        "ErrorMessage": "parse pdf failed",
        "FileName": "manual.pdf",
        "FileSize": 1048576,
        "Metadata": [
          {
            "Key": "department",
            "Value": "R&D"
          }
        ],
        "SourceModifiedTime": 1788000000000,
        "SourceType": "UPLOAD",
        "SourceUri": "oss://my-bucket/docs/handbook.pdf",
        "Status": "COMPLETED",
        "UpdatedAt": "2026-08-24T10:00:00Z"
      }
    ],
    "NextToken": "ca1eb85f5d99c7d6a97e6****",
    "TotalCount": 10
  },
  "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.