What are the API interfaces in Dify? How to use APIs to integrate Dify applications?

Dify provides comprehensive API interfaces that allow developers to integrate AI applications into their systems. Main API types include:

1. Chat API

   • Endpoint: /v1/chat-messages
   • Function: Send messages and get AI responses
   • Supports streaming and blocking responses
   • Supports multi-turn conversation context

2. Workflow API

   • Endpoint: /v1/workflows/run
   • Function: Trigger workflow execution
   • Supports passing input parameters
   • Returns workflow execution results

3. Knowledge Base API

   • Endpoint: /v1/datasets/{dataset_id}/documents
   • Function: Manage knowledge base documents
   • Supports uploading, deleting, querying documents

4. App Management API

   • Endpoint: /v1/apps/{app_id}
   • Function: Get app information and configuration
   • Supports app list queries

API Authentication:

• Use API Key for authentication
• Generate API Key in app settings
• Add Authorization: Bearer {api_key} to request headers

Usage example (Python):

python
import requests

url = "https://api.dify.ai/v1/chat-messages"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "inputs": {},
    "query": "Hello",
    "user": "user-123",
    "response_mode": "blocking",
    "conversation_id": ""
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

Candidates should understand the basic usage of Dify APIs and how to integrate Dify functionality into their applications.