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

# パイプラインファイルをアップロード

> ナレッジパイプラインで使用するファイルをアップロードします。返された `id` を [パイプラインを実行](/ja/3.13.x/develop/api/knowledge-pipeline/run-pipeline) の `local_file` アイテムの `reference` として使用します。



## OpenAPI

````yaml /ja/3.13.x/develop/api/openapi_service.json post /datasets/pipeline/file-upload
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: テキスト生成に関連する操作です。
  - name: ナレッジベース
    description: ナレッジベースの作成、設定、取得を含むナレッジベース管理の操作です。
  - name: ドキュメント
    description: ナレッジベース内のドキュメントの作成、更新、管理のための操作です。
  - name: チャンク
    description: ドキュメントチャンクと子チャンクの管理のための操作です。
  - name: メタデータ
    description: ナレッジベースのメタデータフィールドとドキュメントメタデータ値の管理のための操作です。
  - name: タグ管理
    description: ナレッジベースタグとタグバインディングの管理のための操作です。
  - name: モデル
    description: 利用可能なモデルを取得するための操作です。
  - name: ナレッジパイプライン
    description: データソースプラグインとパイプライン実行を含むナレッジパイプラインの管理と実行のための操作です。
  - name: デプロイ環境
    description: >-
      デプロイ環境が `v2` ベース URL
      で提供するエンドポイントです。デプロイ環境が提供するのはこのグループのエンドポイントだけで、それ以外のパスを呼び出すと `404
      not_found` が返ります。認証とエラーは標準の Service API
      とは異なります。デプロイ環境については、このグループの各ページが正式な情報源です。
paths:
  /datasets/pipeline/file-upload:
    post:
      tags:
        - ナレッジパイプライン
      summary: パイプラインファイルをアップロード
      description: >-
        ナレッジパイプラインで使用するファイルをアップロードします。返された `id` を
        [パイプラインを実行](/ja/3.13.x/develop/api/knowledge-pipeline/run-pipeline) の
        `local_file` アイテムの `reference` として使用します。
      operationId: uploadPipelineFileJa
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    アップロードするファイル。`multipart/form-data` の 1 パートとして送信します。ファイル名に
                    `/` や `\` は使えません。


                    デプロイのセキュリティブラックリスト（`UPLOAD_FILE_EXTENSION_BLACKLIST`、デフォルトは空）にある拡張子を除き、任意の拡張子を受け付けます。


                    サイズ上限のデフォルト値はカテゴリごとに、画像 5 MB、音声 50 MB、動画 100 MB、その他のファイル 15
                    MB です。Docker Compose でデプロイした場合、画像の上限は 10 MB
                    です。これらの上限は、プラットフォームの管理者が `UPLOAD_*_FILE_SIZE_LIMIT`
                    [環境変数](/ja/3.13.x/deploy/advanced-configuration/environment-variables)
                    で変更できます。
      responses:
        '201':
          description: ファイルが正常にアップロードされました。
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: アップロードされたファイルの一意識別子。
                  name:
                    type: string
                    description: 元のファイル名。
                  size:
                    type: integer
                    description: ファイルサイズ（バイト）。
                  extension:
                    type: string
                    description: ファイル拡張子。
                  mime_type:
                    type: string
                    description: ファイルの MIME タイプ。
                  created_by:
                    type: string
                    description: ファイルをアップロードしたユーザーの ID。
                  created_at:
                    type: string
                    description: アップロードのタイムスタンプ（ISO 8601 形式）。
              examples:
                success:
                  summary: レスポンス例
                  value:
                    id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    name: report.pdf
                    size: 524288
                    extension: pdf
                    mime_type: application/pdf
                    created_by: ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4
                    created_at: '2025-03-06T12:00:00'
        '400':
          description: >-
            - `no_file_uploaded` : リクエストにファイルが含まれていません。

            - `filename_not_exists_error` : アップロードされたファイルにファイル名がありません。

            - `too_many_files` : 1 回のリクエストにつき 1 ファイルのみ許可されています。

            - `invalid_param` : `file` パートに MIME タイプが宣言されていません。`message`
            は空文字列です。

            - `invalid_param` : ファイル名に `/` または `\` が含まれています。

            - `invalid_param` : ファイルの拡張子がデプロイのセキュリティブラックリストにあります（`file`
            フィールドを参照）。
          content:
            application/json:
              examples:
                no_file_uploaded:
                  summary: no_file_uploaded
                  value:
                    status: 400
                    code: no_file_uploaded
                    message: Please upload your file.
                filename_not_exists_error:
                  summary: filename_not_exists_error
                  value:
                    status: 400
                    code: filename_not_exists_error
                    message: The specified filename does not exist.
                too_many_files:
                  summary: too_many_files
                  value:
                    status: 400
                    code: too_many_files
                    message: Only one file is allowed.
                invalid_param:
                  summary: invalid_param（MIME タイプなし）
                  value:
                    status: 400
                    code: invalid_param
                    message: ''
                invalid_param_extension:
                  summary: invalid_param（ブラックリストの拡張子）
                  value:
                    status: 400
                    code: invalid_param
                    message: File extension '.exe' is not allowed for security reasons
                invalid_param_filename:
                  summary: invalid_param（ファイル名）
                  value:
                    status: 400
                    code: invalid_param
                    message: Filename contains invalid characters
        '403':
          content:
            application/json:
              examples:
                forbidden:
                  summary: forbidden（API キーのスコープ）
                  value:
                    code: forbidden
                    message: >-
                      The API key is not authorized to access this knowledge
                      base.
                    status: 403
          description: >-
            `forbidden` : この API キーは特定のナレッジベースに限定されています。このエンドポイントはパスにナレッジベース ID
            を含まないため、すべてのナレッジベースにアクセスできる API キーが必要です。
        '413':
          description: >-
            `file_too_large` : ファイルがカテゴリごとのサイズ上限（`file`
            フィールドを参照）を超えています。現在、`message` は空文字列で返ります。`code` と HTTP
            ステータスコードで判定してください。
          content:
            application/json:
              examples:
                file_too_large:
                  summary: file_too_large
                  value:
                    status: 413
                    code: file_too_large
                    message: ''
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        すべてのリクエストは API キーで認証します：`Authorization: Bearer
        {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API
        キーを使用します（[Dify API
        クイックスタート](/ja/3.13.x/develop/api/guides/get-started)）。


        キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP
        `401`（`unauthorized`）が返ります。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.