API Reference

The Functor API provides a comprehensive REST interface for knowledge graph operations, natural language querying, data ingestion, and system monitoring. All endpoints follow RESTful conventions and return JSON responses.

Functor provides standard HTTP API interfaces that support multiple programming languages and development environments, with SDKs also available.

Authentication

The Functor API uses API Keys for authentication. An API key is required, which you can create or manage on the API Keys Page (local).

API keys should be provided via the X-API-Key header in HTTP requests.

X-API-Key: YOUR_API_KEY

Playground

The API Playground allows developers to quickly try out API calls. Simply click Try it on any API endpoint display to get started.

• On the API details page, you can interact directly with the endpoint.
• You can switch input types and modify parameters.

Call Examples

curl -X POST "http://localhost:8000/api/v1/query" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
      "query": "What is the relationship between episodic and semantic memory?",
      "user_id": "user_123",
      "stream": false
  }'

API Endpoints

The API is organized into 7 main categories with 70+ endpoints:

Response Format

All responses are JSON objects with consistent structure:

{
  "answer": "Machine learning is a subset of AI...",
  "pipeline_used": "knowledge_graph",
  "citations": [...],
  "processing_time_ms": 423.5
}

{
  "detail": "Invalid API key",
  "status_code": 401,
  "error_type": "authentication_error"
}

HTTP Status Codes

SDKs

Official SDKs are available for easier integration: