Skip to main content
GET
同期ポリシーを取得

Authorizations

Authorization
string
header
required

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの 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 です。ソース一覧を取得 から取得します。

Response

同期スケジュールです。

created_at
string

作成日時(ISO 8601)です。

custom_interval_seconds
integer | null

mode: custom の場合の間隔(秒)です。ほかのモードでは null です。

enabled
boolean

スケジュール同期を実行するかどうかです。mode: manual では常に false です。

expected_source_version
integer

スケジュールが紐付いているソースの version です。

id
string

同期ポリシー ID です。更新しても変わりません。

knowledge_space_id
string

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

mode
string

manual(スケジュールなし)、interval(24 時間ごと)、custom(custom_interval_seconds ごと)のいずれかです。

next_run_at
string | null

次回のスケジュール同期の予定日時(ISO 8601)です。予定がない場合は null です。

revision
integer

スケジュールのリビジョンです。同期ポリシーを更新 で expectedRevision として送信します。更新のたび、およびスケジュール同期が開始されるたびに増加します。

source_id
string

スケジュールが属するソースです。

updated_at
string

最終更新日時(ISO 8601)です。スケジュール同期が開始されたときにも更新されます。