External Knowledge API

Editor: Allen. Dify Technical Writer

Knowledge Retrieval API

This API is used to connect to a knowledge base that is independent of the Dify and maintained by developers. For more details, please refer to Connecting to an External Knowledge Base. You can use API-Key in the Authorization HTTP Header to verify permissions, the authentication logic is defined by you in the retrieval API, as shown below:

Authorization: Bearer {API_KEY}

POSTyour-endpoint/retrieval

Authorization

bearer

Body

application/json

knowledge_id*string

Your knowledge's unique ID

query*string

User's query

retrival_setting*object

Knowledge's retrieval parameters

Response

200403500

If the action is successful, the service sends back an HTTP 200 response.

Body

application/json

records*A list of records from querying the knowledge base.

Request

JavaScriptCurlPython

const response = await fetch('your-endpoint/retrieval', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "knowledge_id": "your-knowledge-id",
      "query": "your question",
      "retrival_setting": {
        "top_k": 2,
        "score_threshold": 0.5
      }
    }),
});
const data = await response.json();

Response

200403500

{
  "records": {
    "content": "text",
    "score": 0,
    "title": "text",
    "metadata": "text"
  }
}