API Reference

Integrate your NovaHost-powered AI platform into any application. RESTful API with full chat, knowledge base, and workflow support.

Quick Start

# Send a chat message to your AI instance

curl -X POST https://your-instance.novahost.ai/api/v1/chat-messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What are our return policies?",
    "user": "user-123",
    "response_mode": "streaming"
  }'

Base URL

Each NovaHost instance has a unique base URL. Find yours in the dashboard under Instance Settings.

https://your-instance.novahost.ai/api/v1

Authentication

Authenticate API requests with your instance API key.

POST/api/v1/auth/token
GET/api/v1/auth/me

Chat & Completions

Send messages and receive AI-generated responses from your chatbot apps.

POST/api/v1/chat-messages
POST/api/v1/completion-messages
GET/api/v1/messages
DELETE/api/v1/conversations/:id

Knowledge Base

Manage documents and datasets for RAG-powered knowledge bases.

POST/api/v1/datasets
POST/api/v1/datasets/:id/documents
GET/api/v1/datasets/:id/documents
DELETE/api/v1/datasets/:id/documents/:doc_id

Workflows

Trigger and manage AI workflow executions programmatically.

POST/api/v1/workflows/run
GET/api/v1/workflows/:id/runs
GET/api/v1/workflows/:id/runs/:run_id
POST/api/v1/workflows/:id/stop

Webhooks

Receive real-time notifications for events in your AI platform.

POST/api/v1/webhooks
GET/api/v1/webhooks
DELETE/api/v1/webhooks/:id

SDKs & Libraries

Official client libraries to integrate NovaHost AI into your applications.

Python

pip install dify-client

JavaScript

npm install dify-client

cURL

No installation needed

Need help with the API? Our team is here to assist.

View Full Documentation