Reference

API documentation and configuration reference.

Overview

This section provides technical reference documentation for APIs, configuration, and system specifications.

Documents

1. API Reference

REST API endpoints and schemas.

  • Authentication (JWT tokens)
  • POST /chat endpoint
  • Webhook endpoints (/webhooks/fathom, /helpscout, /linear)
  • Rate limits and error codes
  • Request/response examples

Audience: Engineers integrating with the API Time: 10 minutes

2. Glossary (Coming Soon)

Terminology and definitions.

Quick Reference

API Endpoint 

https://[api-gateway-url]/chat

Authentication 

Authorization: Bearer <jwt-token>

Example Request 

curl -X POST https://[api-url]/chat \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is the system architecture?",
    "max_results": 5
  }'

Example Response 

{
  "query": "What is the system architecture?",
  "answer": "The system uses a serverless architecture...",
  "sources": [
    {
      "document_number": 1,
      "relevance_score": 0.85,
      "snippet": "...",
      "metadata": {
        "title": "System Architecture",
        "source": "confluence"
      }
    }
  ]
}

Related: Operations - Data Ingestion for webhook setup.

Table of contents