GetLumaDocument - EventBridge - Alibaba Cloud Documentation Center

Operation description

Retrieves the details of a specified document in the knowledge base bound to a Luma Agent.

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	Yes	The unique identifier of the document. You can call ListLumaDocuments to obtain this value.	doc-a1b2c3d4

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 identifier of the request, used for troubleshooting and ticket submission.	34AD682D-5B91-5773-8132-AA38C130****
Data	KnowledgeBaseDocument	The document details, including the processing status and metadata.
Code	string	The response code returned by the operation. A value of Success indicates that the call succeeds. Otherwise, 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": {
    "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"
  },
  "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.