DriftOSDriftOS
Reference

Configuration

All configuration options for DriftOS

Complete configuration reference for DriftOS.

Flowise Node Configuration

Required Settings

Use Hosted API

  • Type: Boolean
  • Default: ON
  • Description: Use DriftOS cloud service or self-hosted instance

Routing

  • Type: Dropdown
  • Options: driftos-core, driftos-embed
  • Default: driftos-core
  • Description: Routing engine selection

Use Flowise Chat ID

  • Type: Boolean
  • Default: ON
  • Description: Use Flowise-generated chat ID or custom ID

Optional Settings

Custom Endpoint

  • Type: String
  • Default: N/A
  • Description: Self-hosted DriftOS URL (when Use Hosted API is OFF)
  • Example: https://your-server.com

Chat ID

  • Type: String
  • Default: N/A
  • Description: Custom conversation ID (when Use Flowise Chat ID is OFF)

Memory Key

  • Type: String
  • Default: chat_history
  • Description: Variable name for context injection

Max Context Messages

  • Type: Number
  • Default: 10
  • Description: Maximum messages in context window

System Prompt

  • Type: String
  • Default: Empty
  • Description: Custom system prompt for LLM

SDK Configuration

createDriftClient()

const drift = createDriftClient(baseUrl, apiKey, options);

Parameters:

baseUrl (required)

  • Type: String
  • Core: https://api.driftos.dev/api/v1/llm
  • Embed: https://api.driftos.dev/api/v1/embed
  • Self-hosted: Your server URL

apiKey (required)

  • Type: String
  • Format: sk-drift-xxxxxxxxxxxxxxxxxxxxxxxx
  • Get from: driftos.dev

options (optional)

  • Type: Object
  • Fields: timeout, retries, debug

Example:

const drift = createDriftClient(
  'https://api.driftos.dev/api/v1/embed',
  process.env.DRIFTOS_API_KEY,
  {
    timeout: 5000,
    retries: 3,
    debug: true
  }
);

Environment Variables

SDK/API

DRIFTOS_API_KEY

  • Your DriftOS API key
  • Required for all API calls

DRIFTOS_BASE_URL (optional)

  • Override default base URL
  • Useful for self-hosted instances

DRIFTOS_TIMEOUT (optional)

  • Request timeout in milliseconds
  • Default: 30000 (30 seconds)

Example .env:

DRIFTOS_API_KEY=sk-drift-xxxxxxxxxxxxxxxxxxxxxxxx
DRIFTOS_BASE_URL=https://your-server.com
DRIFTOS_TIMEOUT=5000

Self-Hosted Configuration

Coming soon.

Self-hosted configuration docs will be added when self-hosting is available.


Next Steps

On this page