Skip to main content
The Worlds Platform is designed to be highly configurable across different scenarios through environment variables.

Management console

These variables are required in the Console environment configuration file for production deployments.
VariableModePurpose
WORKOS_API_KEYProductionEnables remote WorkOS management.
WORKOS_CLIENT_IDProductionRequired for AuthKit login.
WORKOS_COOKIE_PASSWORDProductionPassword for encrypting secure session cookies.
WORKOS_REDIRECT_URIProductionThe AuthKit redirect URI (e.g., http://localhost:3000/callback).
DENO_DEPLOY_TOKENProductionEnables remote Deno Deploy orchestration.
TURSO_API_TOKENProductionEnables remote Turso database provisioning.
TURSO_ORGProductionDefines the Turso organization slug.
WORLDS_EMBEDDINGS_DIMENSIONSBothSets unified vector dimensions for DB and AI. Defaults to 768.
OPENROUTER_API_KEYBothProvides a global fallback for embeddings.
OPENROUTER_MANAGEMENT_KEYProductionEnables automatic per-app API key generation via OpenRouter API.
OLLAMA_BASE_URLBothSets Ollama API URL. Defaults to http://127.0.0.1:11434.
OLLAMA_EMBEDDINGS_MODELBothSets Ollama model. Defaults to nomic-embed-text.

World server

The console automatically provisions and injects these variables during deployment. You only need to set them manually if you are self-hosting the server.
VariablePurpose
WORLDS_API_KEYSets the root admin key for the server. If omitted, the server runs in unprotected mode.
WORLDS_EMBEDDINGS_DIMENSIONSSets unified vector dimensions for DB and AI. Defaults to 768.
WORLDS_BASE_DIRDefines the base directory for local world storage. Defaults to ./worlds.
LIBSQL_URLDefines the connection string. Defaults to file:./worlds.db.
LIBSQL_AUTH_TOKENProvides the auth token for remote libSQL/Turso instances.
TURSO_API_TOKENEnables remote Turso database provisioning for managed worlds.
TURSO_ORGRequired if TURSO_API_TOKEN is set.
OPENROUTER_API_KEYEnables high-quality OpenRouter embeddings.
OPENROUTER_EMBEDDINGS_MODELSets OpenRouter model. Defaults to openai/text-embedding-3-small.
OLLAMA_BASE_URLSets Ollama API URL. Defaults to http://127.0.0.1:11434.
OLLAMA_EMBEDDINGS_MODELSets Ollama model. Defaults to nomic-embed-text.

CLI

The Worlds CLI utilizes environment variables for both remote and local operations.
VariableModePurpose
WORLDS_API_KEYRemoteYour API key for connecting to a remote server.
WORLDS_BASE_URLRemoteAPI base URL for remote mode (e.g., https://api.wazoo.dev).
LIBSQL_URLLocalDatabase connection URL for local in-process server mode.
OPENROUTER_API_KEYChatEnables AI chat functionality via OpenRouter.
OPENROUTER_MODELChatSets the model for AI chat. Defaults to google/gemini-2.0-flash-001.

Embedding providers

The platform selects an embedding provider based on available environment variables:
  • OpenRouter: Triggered when OPENROUTER_API_KEY is present. Recommended for cloud-based AI.
  • Ollama: Default provider when no cloud keys are present. Recommended for local development and private hosting.