Interface MosaiaConfig

Configuration interface for the Mosaia SDK

This interface defines all configuration options available when initializing the Mosaia SDK client. It includes authentication settings, API endpoints, and optional context parameters.

Example

const config: MosaiaConfig = {
  apiKey: 'your-api-key',
  apiURL: 'https://api.mosaia.ai',
  clientId: 'your-client-id',
  user: 'user-id',
  org: 'org-id'
};

Example

// Minimal configuration with just API key
const config: MosaiaConfig = {
  apiKey: 'your-api-key'
};

// Full configuration with OAuth support
const config: MosaiaConfig = {
  apiKey: 'your-api-key',
  apiURL: 'https://api.mosaia.ai',
  version: '1',
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  user: 'user-id',
  org: 'org-id',
  verbose: true,
  session: {
    accessToken: 'token',
    refreshToken: 'refresh-token',
    authType: 'oauth'
  }
};
interface MosaiaConfig {
    apiKey?: string;
    version?: string;
    apiURL?: string;
    clientId?: string;
    clientSecret?: string;
    verbose?: boolean;
    session?: SessionCredentials;
}

Properties

apiKey? version? apiURL? clientId? clientSecret? verbose? session?

Properties

OptionalapiKey

apiKey?: string

API key for authentication (optional if using OAuth)

Optionalversion

version?: string

API version to use (defaults to '1')

OptionalapiURL

apiURL?: string

Base URL for API requests (defaults to https://api.mosaia.ai)

OptionalclientId

clientId?: string

Client ID for client credentials flows (Optional)

OptionalclientSecret

clientSecret?: string

Client secret for client credentials flow (optional)

Optionalverbose

verbose?: boolean

Enable verbose HTTP request/response logging (defaults to false)

Optionalsession

session?: SessionCredentials

Session credentials for OAuth and token-based authentication (optional)

Settings

Member Visibility

On This Page

Properties