SDKs

Tachyon's SDKs are thin, fully-typed wrappers over the JSON/HTTP API — same resources, same error codes, same defaults as talking to the API directly, just idiomatic bindings for your language. Source lives in adikeshri/tachyon-sdk under the Apache 2.0 license.

Quickstart

Each SDK follows the same shape: construct a client, create a collection, index documents, search.

import { Tachyon } from 'tachyon-sdk';

const client = new Tachyon({ url: 'http://localhost:8108', apiKey: 'my-admin-key' });

await client.collections.create({
  name: 'products',
  fields: [{ name: 'title', type: 'text' }],
});

await client.collection('products').documents.index({ id: '1', title: 'Wireless Mouse' });

const results = await client.collection('products').search({ q: 'wireless mouse' });

What every SDK covers

• Collections — create, list, retrieve, delete
• Documents — index (single or batch upsert), retrieve, delete
• Search — full parameter set: filter, sort, facet, pagination, prefix, typo tolerance, match mode
• Autocomplete — suggest
• Analytics — top queries, zero-result queries, latency (in-memory, reset on server restart)
• Operations — health (no API key required) and metrics (Prometheus exposition format)
• Typed errors — one exception/error class per HTTP status, carrying the server's stable error code — see each SDK's page for the full table

All three accept an admin key (read/write) or a search key (read-only) the same way the REST API does — see Configuration.

Choose an SDK

• TypeScript / JavaScript
• Python
• C# / .NET