All Products
Search

This Product

    EventBridge:GetLumaDocumentDownloadUrl

    Document Center

    EventBridge:GetLumaDocumentDownloadUrl

    Last Updated:Sep 15, 2026

    Retrieves a temporary download URL for a specified document in the knowledge base bound to a Luma Agent. The URL is valid for one hour by default.

    Operation description

    Retrieves a temporary download URL for a specified document in the knowledge base bound to a Luma Agent. The URL is valid for one hour by default.

    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
    NetworkType

    string

    No

    Valid values:

    • public: public network.

    • vpc: internal network.

    Default value: public.

    public

    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. Use this ID for troubleshooting or when submitting a ticket.

    34AD682D-5B91-5773-8132-AA38C130****
    Data

    object

    The pre-signed download URL information for the original document.

    DownloadUrl

    string

    The pre-signed download URL for the original document. The URL is valid for a limited period of time.

    https://my-bucket.oss-cn-hangzhou.aliyuncs.com/kb/doc-bp1xxxxxxxxxxxx?Expires=1788000000&Signature=xxxx
    ExpireAt

    string

    The expiration time of the download URL in UTC.

    2026-08-24T12:00:00Z
    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": {
    "DownloadUrl": "https://my-bucket.oss-cn-hangzhou.aliyuncs.com/kb/doc-bp1xxxxxxxxxxxx?Expires=1788000000&Signature=xxxx",
    "ExpireAt": "2026-08-24T12:00:00Z"
  },
  "Code": "Success",
  "Success": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    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.