The Opensolr REST API
What you do in the Control Panel, and more, is one HTTPS call away. Every endpoint has the same shape, https://HOST/solr_manager/api/METHOD, and every call sends your account email and an API key.
The two hosts do not overlap. Each knowledge base article shows the right host for its endpoint.
Calling the wrong host
- An AI or Data Ingestion method on opensolr.com answers 404 with
WRONG_API_HOST, the right host and the right URL. - A management method on api.opensolr.com answers 404 Not Found.
On api.opensolr.com the shorter form https://api.opensolr.com/api/METHOD works too.
Every endpoint, by group
Each group is a section of the knowledge base, with one article per endpoint: parameters, an example and the answer.
- Index Management: create, list, inspect, reload, reset and delete indexes.
- Config Files: read, upload and delete the configuration files of an index.
- Security: HTTP Basic Auth and IP rules.
- Backup Management: create, list and restore backups.
- Cluster Management: clusters and replication.
- Logs & Analytics: request log, error log and traffic.
- Web Crawler: start, stop and follow the crawl of your site.
- Data Ingestion: push your own documents and files, and follow the queue.
- AI API: meaning vectors, hybrid search, answers, pictures and documents.
- Geolocation: IP addresses, coordinates and place names.
What your site search can do by API, explained feature by feature: Everything your site search can do by API.
Is an index ready?
Data Ingestion, search by meaning and PDF pages need the Opensolr schema on the index. check_schema tells you what an index can do and apply_schema installs the schema: Check and install the schema.
Before your first call
- Authentication and keys: your email, the master key, scoped keys and signed calls.
- Public demo account: try every call without an account.
- Rate limits: calls per minute and per hour.
- API Quota: which calls use your monthly AI allowance.
- Error responses: what each answer means.
- Code examples: start from working code.