Docs K  Search
Docs/Reference/API reference
Reference

API Reference

Complete reference for all Hebbrix API endpoints. All endpoints require authentication via API key in the Authorization header.

Base URL

Base URL
https://api.hebbrix.com/v1

All API requests should be made to this base URL. HTTPS is required.

Authentication

Include your API key in the Authorization header:

Authorization
Authorization: Bearer mem_sk_your_api_key

Learn more about authentication

Resources

  • Memories: Create, retrieve, update, and delete memory entries (/v1/memories)
  • Search: Semantic and hybrid search across memories (/v1/search)
  • Chat Completions: OpenAI-compatible chat with memory injection (/v1/chat)
  • Collections: Organize memories into collections (/v1/collections)
  • Documents: Upload and process documents (/v1/documents)
  • Profile: User profile and preferences (/v1/profile)
  • Knowledge Graph: Entities and relationships (/v1/knowledge-graph)
  • Webhooks: Event notifications (/v1/webhooks)
  • Usage & Billing: Monitor usage and manage subscription (/v1/usage)
  • Learning & Feedback: Confidence, corrections, decisions, and feedback for agent learning (/v1/confidence)

All Endpoints

Memories

View documentation →

FieldTypeDescription
POST /v1/memoriesPOSTCreate a memory (Mem0-compatible)
POST /v1/memories/rawPOSTDirect memory creation (no ML)
POST /v1/memories/processPOSTEnterprise memory management (extract, conflict-resolve)
POST /v1/memories/batchPOSTBatch create (max 100)
GET /v1/memoriesGETList all memories
GET /v1/memories/{id}GETGet a specific memory
PATCH /v1/memories/{id}PATCHUpdate a memory
DELETE /v1/memories/{id}DELETEDelete a memory
POST /v1/memories/bulk-deletePOSTBulk delete by IDs (max 500)
DELETE /v1/memories/allDELETEDelete all memories

View documentation →

FieldTypeDescription
POST /v1/searchPOSTHybrid search across memories
POST /v1/search/advancedPOSTAdvanced search with filters and boosting
GET /v1/search/similar/{id}GETFind similar memories
POST /v1/search/graphPOSTKnowledge graph search
POST /v1/search/reasonPOSTAnswer questions using memories + LLM

Chat Completions

View documentation →

FieldTypeDescription
POST /v1/chat/completionsPOSTCreate chat completion

Collections

View documentation →

FieldTypeDescription
POST /v1/collectionsPOSTCreate a collection
GET /v1/collectionsGETList all collections
GET /v1/collections/defaultGETGet default collection
GET /v1/collections/{id}GETGet a collection
PATCH /v1/collections/{id}PATCHUpdate a collection
DELETE /v1/collections/{id}DELETEDelete a collection
POST /v1/collections/bulk-deletePOSTBulk delete collections
DELETE /v1/collections/allDELETEDelete all collections

Documents

View documentation →

FieldTypeDescription
POST /v1/documents/uploadPOSTUpload a document (multipart form; `file` + optional `collection_id` as form fields)
GET /v1/documentsGETList all documents
GET /v1/documents/{id}GETGet document details
GET /v1/documents/{id}/chunksGETGet document chunks
DELETE /v1/documents/{id}DELETEDelete a document

Profile

View documentation →

FieldTypeDescription
GET /v1/profileGETGet user profile
PATCH /v1/profilePATCHUpdate profile
POST /v1/profile/dialecticPOSTDialectic conversation
DELETE /v1/profileDELETEDelete profile

Knowledge Graph

View documentation →

FieldTypeDescription
GET /v1/knowledge-graph/entitiesGETList entities
GET /v1/knowledge-graph/entities/{entity_name}GETGet entity details
POST /v1/knowledge-graph/entitiesPOSTCreate an entity
DELETE /v1/knowledge-graph/entities/{entity_name}DELETEDelete an entity
POST /v1/knowledge-graph/relationshipsPOSTCreate a relationship
DELETE /v1/knowledge-graph/relationshipsDELETEDelete a relationship
POST /v1/knowledge-graph/queryPOSTTemporal query

Webhooks

View documentation →

FieldTypeDescription
POST /v1/webhooksPOSTCreate a webhook
GET /v1/webhooksGETList webhooks
GET /v1/webhooks/{id}GETGet webhook details
PUT /v1/webhooks/{id}PUTUpdate a webhook
DELETE /v1/webhooks/{id}DELETEDelete a webhook
POST /v1/webhooks/{id}/testPOSTSend test event

Usage & Billing

View documentation →

FieldTypeDescription
GET /v1/usageGETGet current usage
GET /v1/usage/historyGETUsage history
GET /v1/billing/subscriptionGETGet subscription
POST /v1/billing/upgradePOSTUpgrade plan
POST /v1/billing/downgradePOSTDowngrade plan
GET /v1/billing/invoicesGETList invoices

Learning & Feedback

View documentation →

FieldTypeDescription
GET /v1/confidenceGETCheck act-vs-ask confidence for a query (?query=...)
POST /v1/correctionsPOSTStore a correction (corrected_content + correction_type: preference|factual|procedural)
GET /v1/corrections/relevantGETGet corrections relevant to a task (?query=...)
POST /v1/decisionsPOSTLog a decision + outcome (decision_type + description). Alias: POST /v1/decisions/log
GET /v1/decisions/similarGETFind similar past decisions (?query=...)
POST /v1/feedback/relevancePOSTSubmit relevance feedback (memory_id, query, is_relevant)
POST /v1/feedback/rankingPOSTSubmit ranking correction (memory_id, query, actual_rank, expected_rank)
POST /v1/feedback/missingPOSTReport a missing result (query, expected_content)
GET /v1/feedback/statsGETAggregate feedback statistics

Response Format

All responses are JSON. Successful responses include the requested data:

200 OK
{
  "id": "mem_abc123",
  "content": "User prefers...",
  "created_at": "2024-01-15T..."
}
4xx/5xx Error
{
  "error": {
    "code": "invalid_request",
    "message": "...",
    "status": 400
  }
}

Learn more about error handling

Pagination

List endpoints use cursor-based pagination with limit and cursor parameters:

Cursor pagination
GET /v1/memories?limit=50&cursor=eyJpZCI6Im1lbV8xMjMifQ
FieldTypeDescription
limitdefault 50 / max 100Number of items to return
cursordefault nullCursor from previous response's next_cursor field

Response includes pagination metadata:

Pagination metadata
{
  "items": [...],
  "next_cursor": "eyJpZCI6Im1lbV83ODkifQ",
  "has_more": true,
  "total_count": 1250
}

Rate Limits

Rate limits vary by tier and endpoint. Check response headers for your current limits:

  • X-RateLimit-Limit: max requests
  • X-RateLimit-Remaining: remaining requests
  • X-RateLimit-Reset: reset timestamp
  • Retry-After: wait time (on 429)

View rate limits by tier

Get Started

Ready to start building? Check out our quickstart guide or explore the SDKs.

Ask the docs
reading · this page

Hi! I'm the Hebbrix docs assistant. Ask me anything about this page: setup, code examples, endpoints, pricing, or integrations.