Environment Variables Reference
3 min read
Complete reference of all environment variables that configure the Web Search tool at the platform level. All variables must be available in the assistants-core pod environment at startup.
Variables are loaded via Pydantic Settings from the process environment and optionally from a .env file.
Core Settings
Variable | Type | Default | Description |
|---|---|---|---|
|
|
| Default search mode for new spaces. |
| JSON array |
| Which search engines are available in the space configuration UI. |
| JSON array |
| Which built-in crawlers are available. |
| string |
| Feature flag to disable the tool entirely. |
Google Search API
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| API key for Google Custom Search JSON API. |
| string |
| API endpoint URL (e.g., |
| string |
| Custom Search Engine ID (cx parameter). |
Bing / Azure AI
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| Azure AI project endpoint URL. |
| string |
| Bing resource connection string from Azure. |
| string | -- (required) | The deployed model name used by the Bing Foundry Agent in auto-provisioned mode. |
| string |
| Pre-configured Foundry Agent ID. When set, skips auto-provisioning and uses this agent as-is. |
Brave Search API
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| API key for Brave Search. |
| string |
| Brave Search API endpoint URL. |
Jina AI
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| API key for Jina AI. Also enables Jina search and crawler. |
| string |
| Jina Search API endpoint. |
| string |
| Jina Reader API endpoint (used by crawler). |
Tavily
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| API key for Tavily. Also enables Tavily search and crawler. |
Firecrawl
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| API key for Firecrawl. Also enables Firecrawl search and crawler. |
VertexAI (Google Cloud)
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| GCP service account credentials (JSON string). |
| list of strings |
| OAuth scopes for the service account. |
Custom API
Variable | Type | Default | Description |
|---|---|---|---|
|
|
| HTTP method. When set, the field is hidden from space-level config. |
| string |
| API endpoint URL. When set, the field is hidden from space-level config. |
| string (JSON) |
| Request headers. When set, the field is hidden from space-level config. |
| string (JSON) |
| Additional query parameters. When set, the field is hidden from space-level config. |
| string (JSON) |
| Additional request body parameters. When set, the field is hidden from space-level config. |
| string (JSON) |
| HTTP client configuration (e.g., SSL settings). |
Proxy Settings
See 03-proxy.md for detailed proxy configuration documentation.
Variable | Type | Default | Description |
|---|---|---|---|
|
|
| Proxy authentication mode. |
|
|
| Proxy protocol. |
| string |
| Proxy hostname. |
| integer |
| Proxy port number. |
| dict (JSON) |
| Additional headers sent through the proxy. |
| string |
| Custom CA bundle path for proxy SSL verification. |
| string |
| Username for |
| string |
| Password for |
| string |
| Client certificate path for |
| string |
| Client key path for |
Azure Identity
Variable | Type | Default | Description |
|---|---|---|---|
| boolean |
| Whether to use Azure private endpoint transport. |
|
|
| Azure identity credential type. Use |
| string |
| URL used to validate Azure identity tokens. |
Other
Variable | Type | Default | Description |
|---|---|---|---|
| string |
| Environment name (e.g., |
| string |
| Logging level (e.g., |
| string |
| Directory for caching tokenizer data. |