API Reference

Build powerful integrations with the HelpSpace AI API

Getting Started

The HelpSpace AI API allows you to programmatically interact with your knowledge base and AI assistant. All API requests require authentication using an API key.

Base URL

https://api.helpspace.tech/v1

Authentication

Include your API key in the Authorization header:

Authorization: Bearer your-api-key

Endpoints

POST /query

Query the AI assistant with a natural language question.

Request Body

{
  "question": "How do I reset my password?",
  "project_id": "proj_abc123",
  "context": {
    "user_id": "user_123"
  }
}

Response

{
  "answer": "To reset your password...",
  "sources": [...],
  "confidence": 0.95
}
GET /articles

List all articles in your knowledge base.

POST /articles

Create a new article.

GET /search

Search articles using semantic search.

Rate Limits

API requests are limited based on your plan:

  • Starter: 100 requests/minute
  • Professional: 1,000 requests/minute
  • Enterprise: Custom limits

SDKs

We provide official SDKs for popular languages:

  • JavaScript/TypeScript (npm)
  • Python (PyPI)
  • Ruby (RubyGems)
  • Go (go get)