API - Get Vector-Capable Regions

Index Management API

Get Vector-Capable Regions

Returns only the environments where an index can hold vector embeddings and run hybrid search — the regions whose Solr version and crawler stack support the AI API. Use it instead of regions when the index you are about to create will be searched with embed_and_search, fed by the Data Ingestion API or crawled by the Web Crawler.

Endpoint

GET https://opensolr.com/solr_manager/api/vector_regions

Parameters

Parameter	Status	Description
`email`	Required	Your Opensolr registration email address
`api_key`	Required	Your Opensolr API key (master key, or a scoped key that allows this endpoint)

How It Works

The full regions list contains every shared environment Opensolr operates, including legacy Solr 3.x–8.x servers that cannot store dense vectors. vector_regions filters that list down to the web-crawler-enabled servers — the same set the Drupal module, the WordPress plugin and the langchain-opensolr / llama-index-opensolr / opensolr-haystack packages use to pick a region automatically.

Pass the returned environment value as region (or server_country) to create_index.

Response

Key	Type	Description
`environment`	string	The environment identifier to use as `region` when creating an index
`country`	string	Where the server is hosted
`solr_version`	string	Solr version running in that environment

Code Examples

cURL

curl -s "https://opensolr.com/solr_manager/api/vector_regions?email=YOUR_EMAIL&api_key=YOUR_API_KEY"

PHP

$params = http_build_query(['email' => 'YOUR_EMAIL', 'api_key' => 'YOUR_API_KEY']);
$regions = json_decode(file_get_contents("https://opensolr.com/solr_manager/api/vector_regions?{$params}"), true);
foreach ($regions as $r) {
    echo "{$r['environment']} ({$r['country']}, Solr {$r['solr_version']})\n";
}

Python

import requests

r = requests.get("https://opensolr.com/solr_manager/api/vector_regions",
                 params={"email": "YOUR_EMAIL", "api_key": "YOUR_API_KEY"}, timeout=30)
for region in r.json():
    print(region["environment"], region["country"], region["solr_version"])

Example Response

[
  {"environment": "DE-SOLR-9", "country": "Germany", "solr_version": "9.0"},
  {"environment": "FINLAND9", "country": "Finland", "solr_version": "9.6"},
  {"environment": "CHICAGO-96", "country": "USA", "solr_version": "9.6"}
]

Use Cases

Let an integration (CMS module, LangChain vector store, CI pipeline) choose a valid region without hard-coding one
Offer users a region drop-down that only contains AI-capable environments
Validate an existing index’s region before enabling vector embeddings on it