Skip to main content
post/knowledge-fs/spaces/{knowledge_base_id}/sources
Request example
Response
post/knowledge-fs/spaces/{knowledge_base_id}/sources

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/ の後のセグメントです。

Body

application/json
connectionIdstring#
ソースが読み取りに使う認証情報を提供する接続です。このナレッジベースに属し、active である必要があります。ソースの接続一覧を取得 の id から取得します。
metadataobject#

プロバイダーの設定と、機密でない独自のメタデータです。作成時のレスポンスが失われた場合にこのソースを識別できるよう、一意の client_request_id を付けてください。この値はソースとともに返されますが、API は一意性を強制せず、重複したリクエストも排除しません。

providerKind には接続の configuration.providerKind を設定し、それに合ったソースの type を選んでください。接続から取得される設定は、ソースのレスポンスに含まれない場合があります。

既存のソースのレスポンスをもとに metadata を組み立てる場合は、__knowledgeFs で始まるフィールド、credentials、parameters オブジェクトを除いてください。credentialId がある場合は、Dify が保持する認証情報を指します。

namestringrequired#
表示名です。

Length: 1–200

permissionScopestring[]#
空にするか省略してください。空のリストのみ受け付けます。

Items: max 0

statusenum<string>#
disabled にすると、スケジュール同期が一時停止します。

Default: "active"

Options:activedisablednull
typeenum<string>required#
ウェブサイトのクロールには web を、オンラインドキュメントまたはオンラインドライブのプロバイダーには connector を指定します(metadata.providerKind も設定します)。upload と object-storage は、Dify がデータを取り込むソース用の値です。
Options:connectorobject-storageuploadweb
uristringrequired#
web ではクロールのルート URL を指定します。connector では、Dify が書き込む値に合わせて connector://<connectionId> を指定します。

Length: 1–4096

Responses

application/json
作成されたソースです。
connection_idstring#
ソースが認証情報の取得に使用する接続です。別のソースを同じ接続に紐付ける場合は、connectionId として渡します。紐付けられていない場合は null です。
created_atstring#
作成日時(ISO 8601)です。
credential_configuredboolean#
ソースが独自の認証情報の参照を保持している場合は true です。接続に紐付けられたソースのように参照を保持していない場合は null です。
idstring#
ソース ID です。
knowledge_space_idstring#
ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。
last_synced_atstring#
直近に完了した同期(completed または zero_results)またはインポートの完了日時です。ソース一覧を取得 でのみ設定されます。それ以外の操作、およびソースが一度も同期されていない場合は null です。
metadataobject#
プロバイダーの設定と、サーバーが管理する同期データまたはページ選択データです。プロバイダーの識別子や parameters が含まれる場合があります。接続側で管理される設定は、ここに含まれるとは限りません。認証情報に類するキーは除去されます。別のソースを作成する際に、このオブジェクト全体をコピーしないでください。
namestring#
表示名です。
permission_scopestring[]#
このソースを読み取るために必要なコンテンツのアクセス範囲です。空のリストの場合、ナレッジベース内でのコンテンツの制限は追加されません。ナレッジベースの認可は引き続き適用されます。
statusstring#

active、syncing、error、disabled のいずれかです。ほとんどの操作は保存されている値を返します。ソース一覧を取得 は、直近の同期の実行から値を導き出します:

  • failed または canceled の実行:error
  • completed または zero_results の実行:active
  • 進行中の実行:syncing

disabled が上書きされることはありません。

sync_policyobject#
ソースの同期スケジュールです。ソース一覧を取得 でのみ設定されます。それ以外の操作、およびスケジュールがない場合は null です。単独で取得するには 同期ポリシーを取得、変更するには 同期ポリシーを更新 を使用します。
sync_workflowobject#

ソースで進行中の同期またはインポートの実行(crawl-import、online-document-import、online-drive-import)です。進行中の実行がない場合は、直近の同期の実行です。ソース一覧を取得 は、実行が進行中か、ソースより新しい場合に設定します。ソースを更新 は、その呼び出しで同期が開始された場合に設定します。それ以外の場合は null です。クロールプレビューと、そこからのインポートはここに表示されません。

個々の実行を追跡するには、その id を指定して ソースの実行を取得 を呼び出します。

typestring#

web(ウェブサイトのクロール)、connector(オンラインドキュメントまたはオンラインドライブ)、upload、object-storage のいずれかです。

connector ソースでは、metadata.providerKind は online-document または online-drive です。web ソースでは website です。

upload と object-storage のソースには、Dify が内容を追加します。

updated_atstring#
最終更新日時(ISO 8601)です。
uristring#
web ソースでは、クロールのルート URL です。Dify で作成されたコネクタソースでは connector://<connection_id> です。
versioninteger#
ソースのバージョンで、書き込みのたびに増加します。ソースを更新 では expectedVersion、ソースを削除 では expectedRevision、同期ポリシーを更新 では expectedSourceVersion として送信します。