REST API Reference

Integrate Broomed licensing, verify entitlement tokens, and interface with our AI Gateway.

POST /api/v1/license/activate

Redeems a single-use 15-character activation code to bind a desktop client device and issue a 7-day cryptographic entitlement JWT.

Request Body (JSON)

{
  "activation_code": "A9X7K-B32RT-Q8L9P",
  "device_public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5...",
  "platform": "darwin",
  "app_version": "1.0.0",
  "fingerprint": {
    "hostname": "macbook-pro"
  }
}

Response (200 OK)

{
  "status": "activated",
  "license": {
    "session": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_at": "2026-08-30T12:00:00.000Z",
    "subscription_period_end": "2026-09-23T12:00:00.000Z"
  },
  "device_id": "8f3b2c1a-5d4e-4f3a-9b1c-2d3e4f5a6b7c"
}

POST /api/v1/license/refresh

Refreshes an existing entitlement session before expiration. Requires Bearer authentication with the active JWT.

Headers

Authorization: Bearer <session_token>

Response (200 OK)

{
  "status": "refreshed",
  "license": {
    "session": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_at": "2026-09-06T12:00:00.000Z",
    "subscription_period_end": "2026-09-23T12:00:00.000Z"
  }
}

POST /api/v1/ai/text

Inference proxy for text summarization and reasoning tasks. Automatically balances across Gemini 1.5, Groq LLaMA, and OpenRouter providers with quota recovery.

Example cURL Request

curl -X POST https://broomed.app/api/v1/ai/text \
  -H "Authorization: Bearer YOUR_ENTITLEMENT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Extract key action items from this markdown note..."}'

Response (200 OK)

{
  "provider": "groq",
  "model": "llama-3.1-8b-instant",
  "output": "1. Schedule follow-up meeting\n2. Refactor auth service"
}

POST /api/v1/ai/vision

Image understanding and OCR processing endpoint for base64 encoded images up to 5 MB.

Request Body (JSON)

{
  "prompt": "Transcribe the handwritten text on this receipt",
  "image": "iVBORw0KGgoAAAANSUhEUgAA..."
}