Documentation

Everything you need to integrate OloSearch services into your application.

Quick Start

1

Get your API Key

Sign up and generate an API key from the dashboard

2

Install the SDK

npm install @voltimap/sdk or use REST API directly

3

Make your first call

Initialize the client and call any of the 9 services

Installation

$ npm install @voltimap/sdk
// Initialize the client
import { OloSearch } from '@voltimap/sdk'

const olo = new OloSearch({
apiKey: 'olo_sk_live_...',
baseUrl: 'https://api.voltimap.com'
})

// Use any service
const results = await olo.search('hello world')
const route = await olo.maps.route('Istanbul', 'Ankara')
const answer = await olo.ai.chat('What is OloSearch?')

API Reference

Base URL: https://api.voltimap.com | Authentication: Authorization: Bearer olo_sk_...

Maps

POST/api/v1/maps/geocode
GET/api/v1/maps/reverse
GET/api/v1/maps/route
GET/api/v1/tiles/{z}/{x}/{y}

Search

POST/api/v1/search
POST/api/v1/search/index
POST/api/v1/search/documents

Storage

POST/api/v1/storage/upload
GET/api/v1/storage/files
DELETE/api/v1/storage/files/:id

Auth

POST/api/v1/auth/token
POST/api/v1/auth/register
GET/api/v1/auth/userinfo

Email

POST/api/v1/email/send
GET/api/v1/email/status/:id

Push

POST/api/v1/notify/push
POST/api/v1/notify/topic

Analytics

GET/api/v1/analytics/stats
POST/api/v1/analytics/event

AI

POST/api/v1/ai/chat
POST/api/v1/ai/embeddings
POST/api/v1/ai/generate

Rate Limits

PlanRequests/minRequests/monthBurst
Starter6010,000100/min
Pro300100,000500/min
Enterprise1,000Unlimited2,000/min