SDK ↔ REST mapping

Quick-reference for switching between the TypeScript SDK, Go SDK, and raw REST calls. Covers every API resource.

The TypeScript SDK column reflects @voxburst/sdk v1.3.0. A cell reading “REST only” means that SDK has no wrapper for the endpoint — call it with raw fetch (TypeScript) or http (Go).

Idempotency: All write operations (POST, PATCH, DELETE) accept an Idempotency-Key header. Pass a stable unique key per logical operation to safely retry on network failure without creating duplicates. See Idempotency for key format rules, behavior, and error codes.

OpenAPI spec: The machine-readable contract is available at https://api.voxburst.io/api/openapi.yaml (YAML) or https://api.voxburst.io/api/openapi.json (JSON). Use it with Postman, Insomnia, code generators, or type-safe HTTP clients.

Posts

Accounts

Media

Webhooks

Analytics

The TypeScript SDK wraps four analytics routes; the rest are REST-only, as are all analytics routes in the Go SDK. Use raw fetch (TypeScript) or http.Get (Go) with your API key header for anything not listed as an SDK method below.

Batch

Personas

Hashtag Sets

Contacts

Broadcasts

Sequences

Approval Workflows

Image Generation Jobs

Error class mapping

TypeScript SDK

import { NotFoundError, RateLimitError, ValidationError, VoxBurstError } from '@voxburst/sdk'

Go SDK

import "github.com/fortheanprojects/voxburst-go/voxburst"

SDK-only conveniences

These features are provided by the SDKs and have no direct REST equivalent:

Using the REST API directly alongside an SDK

The SDKs and raw REST calls are fully interoperable — they share the same base URL, auth scheme, and resource IDs. A common pattern is to use the SDK for most operations and raw HTTP for the S3 upload step (which goes directly to S3, not through the VoxBurst API):

// SDK: request the upload URL
const { mediaId, uploadUrl, uploadHeaders } = await fetch('https://api.voxburst.io/v1/media/upload', {
  method: 'POST',
  headers: { 'Authorization': `Bearer ${apiKey}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ filename: 'photo.jpg', contentType: 'image/jpeg', sizeBytes: 204800 }),
}).then(r => r.json())
 
// Raw HTTP: PUT bytes directly to S3 (SDK cannot do this step)
await fetch(uploadUrl, { method: 'PUT', headers: uploadHeaders, body: fileBytes })
 
// SDK: use the mediaId in a post
const post = await client.posts.create({ content: '...', accountIds: ['acc_123'], media: [mediaId] })