Skip to main content
GET
ソースのページ一覧を取得

Authorizations

Authorization
string
header
required

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

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

Path Parameters

knowledge_base_id
string<uuid>
required

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

source_id
string<uuid>
required

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

Query Parameters

cursor
string

前のレスポンスの next_cursor です。中身を解釈せず、文字列として扱ってください。ツリー表示では、view、parentId、limit を変えずに送信してください。

Required string length: 1 - 4096
limit
integer
default:50

1 回のレスポンスで返すページ数です。

Required range: 1 <= x <= 200
view
enum<string>

tree を指定すると、ページツリーの 1 階層だけを返します。対象は最上位、または parentId の下のページです。省略するとフラットな一覧を返します。

公式のデータソースプラグインでツリー表示に対応しているのは GitHub だけで、プラグインのバージョン 0.4.12 以降が必要です。

リポジトリ内のファイルを取得するには、ツリー表示を使ってください。どちらの表示も、対象は最近更新された上位 20 個までのリポジトリです。リポジトリの下で取得できるページは、表示によって異なります。

  • ツリー表示:各リポジトリの下に Contents、Issues(リポジトリで Issue が有効な場合)、Pull requests があります。Contents とその中のフォルダーには、フォルダーとインポートできるテキストファイルがあります。
  • フラットな一覧:各リポジトリと、その README(ある場合)に加え、Issue とプルリクエストをそれぞれ最大 5 件含みます。
Available options:
tree
parentId
string

展開するページの page_id です。以前のツリー表示のレスポンスで has_children が true だったページから取得します。view=tree と一緒に指定してください。

パラメータ名はキャメルケースの parentId です。対応するレスポンスのフィールド名は parent_id で、表記が異なります。

Required string length: 1 - 4096

Response

ワークスペースごとにまとめたページです。

next_cursor
string | null

次のページのカーソルです。最後のページでは null です。cursor として送り返してください。

workspaces
object[]

認証情報で参照できる、プロバイダーのワークスペースです。