API Reference

All API requests require authentication using an API key. You can create API keys from yourdashboard. If your organization provided an API key, you can use it directly; no HyperSpark account required. Ask your org admin about which scopes are enabled.

Authentication Methods

You can authenticate using either method:

curl https://memory.hypersparkai.com//api/v1/memory/recall \
  -H "Authorization: Bearer hsmem_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"query": "user preferences"}'

API Key Format

API keys follow the format hsmem_ followed by 48 hexadecimal characters.

hsmem_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4

API Key Scopes

API keys can have different permission scopes that control what operations they can perform:

All endpoints support an optional tenantId parameter for multi-tenant applications. This allows you to isolate memories by customer or workspace.

// Include tenantId in your request body
{
  "tenantId": "tenant_acme_corp",
  "userId": "user_123",
  "query": "project updates"
}

Response Format

All API responses follow a consistent JSON format with a success indicator:

{
  "success": true,
  "data": {
    // Response data varies by endpoint
  }
}

Usage Headers

Responses include headers to help you track usage:

Error Codes

Next Steps