avaloka
Resources

API reference for builders

A complete reference for our REST APIs, SQL surface and language SDKs — versioned, examples included and OpenAPI-spec backed.

Explore the API

REST API

Stable, versioned endpoints for catalogs, datasets, queries, agents and inference. OpenAPI 3.1 spec available.

SQL surface

Reference for SQL extensions including vector search, model inference and governance functions.

SDKs

Official SDKs for TypeScript, Python, Go and Java with typed clients and streaming helpers.

Auth & rate limits

OAuth 2.0, PATs and workload identity, plus transparent quotas and rate-limit headers on every call.

Built for production workloads

v2.4
Current version
Backwards-compatible since v2.0.
60+
Endpoints
Across the public API surface.
99.99%
API uptime
Trailing 90-day average.
<150ms
P95 latency
From our nearest region.

How it works

  1. 01

    Create a token

    Generate a PAT or OAuth app in your workspace settings with the scopes you need.

  2. 02

    Pick an SDK

    Install the TypeScript, Python, Go or Java client — or call the REST API directly.

  3. 03

    Make a request

    Every endpoint has copy-pasteable cURL, SDK and OpenAPI snippets in the docs.

  4. 04

    Handle errors

    Standardized error codes, retry guidance and idempotency keys for safe retries.

Frequently asked questions

How do you version the API?+

We use major version prefixes (e.g. /v2) and follow a 12-month deprecation policy for any breaking change.

Are webhooks supported?+

Yes. Subscribe to events like 'query.finished' or 'agent.message' with signed payloads and automatic retries.

What's the rate limit?+

Limits vary by plan and endpoint and are returned in response headers. Enterprise customers can request lifts.

Do you have a sandbox?+

Every workspace gets a sandbox environment with seed data so you can build against the API without touching production.

Build on the Avaloka API

Grab an API key and start integrating Avaloka into your product today.

Explore the API