Skip to main content

API Overview

All Brainz Lab products expose REST APIs for integration.

Base URLs

ProductURL
Platformhttps://brainzlab.ai/api/v1
Recallhttps://recall.brainzlab.ai/api/v1
Reflexhttps://reflex.brainzlab.ai/api/v1
Pulsehttps://pulse.brainzlab.ai/api/v1

Authentication

All API requests require authentication via API key:
curl https://recall.brainzlab.ai/api/v1/logs \
  -H "Authorization: Bearer sk_live_xxxxxxxx"
Or via header:
curl https://recall.brainzlab.ai/api/v1/logs \
  -H "X-API-Key: sk_live_xxxxxxxx"

Key Types

KeyPrefixUse
Secret Key (Live)sk_live_Server-side, full access
Secret Key (Test)sk_test_Server-side, test environment
Public Key (Live)pk_live_Client-side, read-only
Public Key (Test)pk_test_Client-side, test environment
Never expose your secret key in client-side code!

Request Format

All POST/PUT requests should use JSON:
curl https://recall.brainzlab.ai/api/v1/logs \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"level": "info", "message": "Hello"}'

Response Format

All responses are JSON:
{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

Error Responses

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid"
  }
}

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden (feature not in plan)
404Not Found
429Rate Limited
500Server Error

Next Steps