> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取上传文件

> 返回通过文件上传创建的文档的源文件，包含带签名的预览和下载链接。仅 `data_source_type` 为 `upload_file` 的文档有源文件。



## OpenAPI

````yaml /zh/2.5.x/develop/api/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/upload-file
openapi: 3.0.1
info:
  title: Dify 服务 API
  description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: Dify 服务 API 的基础 URL。替换为你部署的 API 基础 URL。
    variables:
      api_base_url:
        default: api.example.com/v1
        description: API 基础 URL 的主机与路径，不含 `https://` 前缀。
security:
  - ApiKeyAuth: []
tags:
  - name: 对话消息
    description: 与聊天消息和交互相关的操作。
  - name: 文件操作
    description: 文件上传和预览操作。
  - name: 消息反馈
    description: 用户反馈操作。
  - name: 会话管理
    description: 与管理会话相关的操作。
  - name: 语音与文字转换
    description: 文字转语音和语音转文字操作。
  - name: 应用配置
    description: 获取应用设置和信息的操作。
  - name: 工作流运行
    description: 用于执行和管理工作流的操作。
  - name: 文本生成消息
    description: 文本生成相关操作。
  - name: 知识库
    description: 用于管理知识库的操作，包括创建、配置和检索。
  - name: 文档
    description: 用于在知识库中创建、更新和管理文档的操作。
  - name: 分段
    description: 用于管理分段和子分段的操作。
paths:
  /datasets/{dataset_id}/documents/{document_id}/upload-file:
    get:
      tags:
        - Documents
      summary: 获取上传文件
      description: >-
        返回通过文件上传创建的文档的源文件，包含带签名的预览和下载链接。仅 `data_source_type` 为 `upload_file`
        的文档有源文件。
      operationId: getUploadFile
      parameters:
        - name: dataset_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            知识库 ID。从
            [获取知识库列表](/zh/2.5.x/develop/api/knowledge-bases/list-knowledge-bases)
            获取。
        - name: document_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            文档 ID。从 [获取知识库的文档列表](/zh/2.5.x/develop/api/documents/list-documents)
            获取。
      responses:
        '200':
          description: 源文件详情，包含带签名的预览和下载链接。
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: 文件标识符。
                  name:
                    type: string
                    description: 原始文件名。
                  size:
                    type: integer
                    description: 文件大小（字节）。
                  extension:
                    type: string
                    description: 文件扩展名。
                  url:
                    type: string
                    description: 带签名的文件预览链接。
                  download_url:
                    type: string
                    description: 带签名的文件下载链接（作为附件下载）。
                  mime_type:
                    type: string
                    description: 文件的 MIME 类型。
                  created_by:
                    type: string
                    format: uuid
                    description: 上传该文件的用户 ID。
                  created_at:
                    type: integer
                    format: int64
                    description: 文件上传的 Unix 时间戳。
        '400':
          description: >-
            - `invalid_param` : 文档并非通过文件上传创建（`data_source_type` 不是
            `upload_file`）。

            - `invalid_param` : 文档的数据源信息中没有上传文件 ID。
          content:
            application/json:
              examples:
                invalid_param_1:
                  summary: invalid_param
                  value:
                    status: 400
                    code: invalid_param
                    message: >-
                      Document data source type (notion_import) is not
                      upload_file.
                invalid_param_2:
                  summary: invalid_param
                  value:
                    status: 400
                    code: invalid_param
                    message: Upload file id not found in document data source info.
        '403':
          description: '- `forbidden` : 该知识库未启用 API 访问。'
          content:
            application/json:
              examples:
                forbidden:
                  summary: forbidden (api access)
                  value:
                    status: 403
                    code: forbidden
                    message: Dataset api access is not enabled.
        '404':
          description: |-
            - `not_found` : 未找到知识库。
            - `not_found` : 未找到文档。
            - `not_found` : 未找到上传文件。
          content:
            application/json:
              examples:
                not_found_1:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Dataset not found.
                not_found_2:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: Document not found.
                not_found_3:
                  summary: not_found
                  value:
                    status: 404
                    code: not_found
                    message: UploadFile not found.
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API
        Key，知识库接口使用知识库 API
        Key（[快速开始](/zh/2.5.x/develop/api/guides/get-started)）。


        API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。

````