@solomonai/api v0.28.0

Installation

npm install @solomonai/api

Quickstart

1. Create a new SolomonAI Root Key in the settings.
2. Use the root key to initialize the client:

import { SolomonAI } from '@solomonai/api'

const solomonai = new SolomonAI({ rootKey: '<SOLOMONAI_ROOT_KEY>' })

Important: Always keep your root key safe and reset it if you suspect it has been compromised.

Usage

Verifying a Key

import { verifyKey } from '@solomonai/api'

const { result, error } = await verifyKey('key_123')

if (error) {
  console.error(error.message)
  // Handle potential network or bad request error
  // A link to our docs will be in the `error.docs` field
  return
}

if (!result.valid) {
  // Do not grant access
  return
}

// Process request
console.log(result)

Response Format

All methods return either an error or a result field, never both and never none. This approach helps with proper error handling.

Success Response

{
  result: T // The result depends on what method you called
}

Error Response

{
  error: {
    message: string
    docs: string // URL to relevant documentation
  }
}

Configuration Options

Base URL

You can customize the base URL for all requests:

const solomonai = new SolomonAI({
  rootKey: '<SOLOMONAI_ROOT_KEY>',
  baseUrl: 'https://my.domain',
})

Retries

Configure retry behavior for network errors:

const solomonai = new SolomonAI({
  rootKey: '<SOLOMONAI_ROOT_KEY>',
  retry: {
    attempts: 3,
    backoff: (retryCount) => retryCount * 1000,
  },
})

Disable Telemetry

To opt out of anonymous telemetry data collection:

const solomonai = new SolomonAI({
  rootKey: '<SOLOMONAI_ROOT_KEY>',
  disableTelemetry: true,
})