ソースのファイル一覧を取得

オンラインドライブソースがプロバイダー側で参照できるバケットとファイルを一覧表示します。

ソースは、metadata.providerKind が online-drive の connector ソースである必要があります。

返されたフォルダーを開くには、その id を prefix として渡します。バケットの is_truncated が true の場合は、その continuation_token を continuationToken として渡すと、次のページを読み取れます。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response

{
  "buckets": [
    {
      "bucket": "acme-shared",
      "continuation_token": "eyJwYWdlIjoyfQ",
      "files": [
        {
          "id": "1AbC9dEfGh2IjKl3MnOpQr",
          "name": "Q3-plan.pdf",
          "size": 482113,
          "type": "file"
        },
        {
          "id": "2DeF8gHiJk3LmNo4PqRsTu",
          "name": "Policies",
          "size": null,
          "type": "folder"
        }
      ],
      "is_truncated": true
    }
  ]
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "maxKeys"
      ],
      "type": "less_than_equal"
    }
  ]
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "SOURCE_ONLINE_DRIVE_REQUEST_FAILED",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files

Authorization

Authorizationstringheaderrequired#

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path parameters

knowledge_base_idstringrequired#

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

source_idstringrequired#

ソース ID です。ソース一覧を取得から取得します。

Query parameters

bucketstring#

参照するバケットです。プロバイダーでの名前で指定します。省略すると、ソースに設定されたバケットが使われます。

prefixstring#

フォルダーを開くには、返されたフォルダーの id を prefix として送信します。表示名を送ったり、パスを組み立てたりしないでください。このパラメータを省略すると、ソースに設定された開始位置が使われます。

continuationTokenstring#

前のレスポンスで返された、バケットの continuation_token です。prefix とバケットの指定は同じままにしてください。バケットを指定しておらず、レスポンスの bucket が null の場合は、bucket パラメータを省略します。

Length: 1–4096

maxKeysinteger#

1 回のレスポンスで、バケットごとに返すファイル数です。省略すると、ソースに設定された値が適用されます。設定がない場合は 20 です。

Range: 1–1000

Responses

application/json

バケットとそのファイルです。

bucketsobject[]#

レスポンスに含まれるバケットです。

Show child attributes

bucketstring#

バケット名です。プロバイダーにバケットの概念がない場合は null です。別のページを取得するときは、リクエストのバケット指定を変えないでください。バケットを指定しておらず、この値が null の場合は bucket を省略します。

continuation_tokenstring#

このバケットの次のページを取得するには、この値を continuationToken として渡します。最後のページでは null です。

filesobject[]#

このページのファイルとフォルダーです。

Show child attributes

idstring#

プロバイダーでのファイル ID です。

namestring#

ファイル名またはフォルダー名です。

sizenumber#

サイズ（バイト）です。フォルダーの場合や、プロバイダーがサイズを報告しない場合は null です。

typestring#

プロバイダーが定義するエントリの種類です（例：file、folder）。

is_truncatedboolean#

後続のファイルがある場合は true です。continuation_token を使って次のページを取得します。

ソースのページ一覧を取得同期ポリシーを取得