Skip to content
Voltx
Docs

Start building in minutes

Everything you need to make your first authenticated request, from a token to a response.

Quickstart

1

Create a Personal Access Token

Sign in and open the Developer Portal, then generate a Personal Access Token scoped to what your script needs.

2

Install an SDK

Install the official client for your language of choice.

npm install @voltx/sdk
3

Make your first request

Authenticate with your token and call any endpoint.

import { Voltx } from "@voltx/sdk";

const voltx = new Voltx({ apiKey: process.env.VOLTX_API_KEY });
const me = await voltx.auth.me();
Try it in the Playground
Guides

Go deeper

Interactive API reference

The full OpenAPI 3.1 reference with a live request playground, in-app.

Authentication

API keys, personal access tokens, and service accounts — when to use each.

OAuth applications

Register an app and implement the authorization-code + PKCE flow.

Webhooks

Subscribe to events, verify signatures, and replay failed deliveries.

SDKs

Official clients for TypeScript, Python, and Flutter.

CLI reference

Install the Voltx CLI and script deploys, runs, and log streaming.

Extension Framework

Build Custom Pages, Widgets, Nav entries, and AI Tools for the Marketplace.

Changelog

Every API and platform change, in order.

Questions the docs don't answer?

Reach out and we'll get you unblocked — usually within one business day.

Start FreeBook Demo