Skip to main content
POST
ソースの認証情報をテスト

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

テスト結果です。認証情報が拒否された場合も 200 が返り、valid: false とエラー詳細が含まれます。

code
string | null

valid が false の場合は failure.code です。それ以外の場合は null です。ここでの SOURCE_CREDENTIAL_TEST_FAILED は、プロバイダーが認証情報を拒否したことを意味します。

error
string | null

valid が false の場合は failure.message、それ以外の場合は null です。テキストは失敗の category または code ごとに固定されており、プロバイダー自身の理由が入ることはありません。

failure
object | null

valid が false の場合はエラー詳細です。プロバイダーが理由を示さなかった場合は null です。valid が true の場合は null です。stage は credential-test です。

valid
boolean

プロバイダーが認証情報を受け入れた場合は true です。