API - Get Vector-Capable Regions

Index Management

Lists the regions where an index gets site search, Data Ingestion and hybrid search. Create your index in one of them.

Endpointhttps://opensolr.com/solr_manager/api/vector_regions
MethodGET or POST
Authemail and api_key of your account, as GET or POST parameters: Authentication.

01 · Parameters

nearestOptional

1 adds nearest to every region: true on the one closest to the address the call comes from.

min_solrOptional

With nearest=1: only regions on this Solr version or newer can be the nearest, for example 9.6.

02 · Example

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

03 · Answer

[
    {
        "environment": "DE-SOLR-9",
        "country": "Germany",
        "solr_version": "9.00",
        "latitude": 50.4779,
        "longitude": 12.3713,
        "nearest": true
    },
    {
        "environment": "CHICAGO-96",
        "country": "USA",
        "solr_version": "9.60",
        "latitude": 41.8798,
        "longitude": -87.6285,
        "nearest": false
    }
]

A plain list, without status. Use environment as the region of create_index. The list is live: it changes as regions are added.

04 · Errors

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

ERROR_RATE_LIMIT_PER_MINUTEHTTP 429

Too many calls. Wait for the Retry-After seconds: Rate limits.

05 · Related

Every region, with or without site search: regions.

Developer packages that pick a region by themselves: Developer packages.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.