OpenAPI Spec

https://api.voxburst.io/v1/docs/openapi.yaml   # YAML
https://api.voxburst.io/v1/docs/openapi.json   # JSON

# Fetch YAML
curl -o voxburst.yaml https://api.voxburst.io/v1/docs/openapi.yaml
 
# Fetch JSON
curl -o voxburst.json https://api.voxburst.io/v1/docs/openapi.json

npm install -D openapi-typescript openapi-fetch
npx openapi-typescript https://api.voxburst.io/v1/docs/openapi.yaml -o voxburst.d.ts

// voxburst.d.ts (excerpt — generated from spec)
export interface components {
  schemas: {
    Post: {
      id: string                         // cuid2, e.g. "post_abc123"
      content: string
      contentType: 'TEXT' | 'IMAGE' | 'VIDEO' | 'CAROUSEL' | 'STORY' | 'REEL' | 'THREAD' | null
      status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'partial' | 'failed' | 'cancelled' | 'unpublished'
      scheduledFor: string | null        // ISO 8601 UTC
      publishedAt: string | null
      firstComment: string | null
      firstCommentDelay: number | null
      tags: string[]
      metadata: Record<string, unknown> | null
      media: components['schemas']['MediaObject'][]
      platforms: components['schemas']['PlatformResult'][]
      threadPosts: components['schemas']['ThreadItem'][]
      personaId: string | null
      createdAt: string
      updatedAt: string
    }
    CreatePostInput: {
      content: string
      accountIds: string[]               // required — platform inferred from account
      contentType?: 'TEXT' | 'IMAGE' | 'VIDEO' | 'CAROUSEL' | 'STORY' | 'REEL' | 'THREAD'
      media?: string[]
      scheduledFor?: string
      saveAsDraft?: boolean
      queue?: boolean
      firstComment?: string
      firstCommentDelay?: number
      platformOverrides?: Record<string, { content?: string; media?: string[] }>
      tags?: string[]
      metadata?: Record<string, unknown>
      personaId?: string
      threadPosts?: components['schemas']['ThreadItem'][]
    }
    PlatformResult: {
      postPlatformId: string
      platform: string
      accountId: string
      accountName: string | null
      status: 'pending' | 'publishing' | 'published' | 'failed' | 'skipped'
      platformPostId: string | null
      platformPostUrl: string | null
      publishedAt: string | null
      error: { code: string; message: string } | null
    }
  }
}

import createClient from 'openapi-fetch'
import type { paths } from './voxburst.d.ts'
 
const client = createClient<paths>({
  baseUrl: 'https://api.voxburst.io/v1',
  headers: { Authorization: `Bearer ${process.env.VOXBURST_API_KEY}` },
})
 
// Fully typed — IDE autocompletes fields, flags unknown keys at compile time
const { data, error } = await client.POST('/posts', {
  body: {
    content: 'Hello from a generated client!',
    accountIds: ['acc_abc123'],
    scheduledFor: '2026-07-01T15:00:00Z',
  },
})

npx @openapitools/openapi-generator-cli generate \
  -i https://api.voxburst.io/v1/docs/openapi.yaml \
  -g python \
  -o ./voxburst-client \
  --additional-properties=packageName=voxburst_client,projectName=voxburst-client

import voxburst_client
from voxburst_client.api.posts_api import PostsApi
from voxburst_client.model.create_post_input import CreatePostInput
 
configuration = voxburst_client.Configuration(
    host="https://api.voxburst.io/v1",
    access_token=os.environ["VOXBURST_API_KEY"],
)
 
with voxburst_client.ApiClient(configuration) as api_client:
    api = PostsApi(api_client)
    post = api.create_post(CreatePostInput(
        content="Hello from the generated Python client!",
        account_ids=["acc_abc123"],
        scheduled_for="2026-07-01T15:00:00Z",
    ))
    print(f"Created: {post.id}")

npx openapi-zod-client https://api.voxburst.io/v1/docs/openapi.yaml \
  -o voxburst-schemas.ts

// voxburst-schemas.ts (excerpt — matches API contract)
import { z } from 'zod'
 
export const CreatePostInputSchema = z.object({
  content: z.string().max(10_000),
  accountIds: z.array(z.string()).min(1),
  contentType: z.enum(['TEXT', 'IMAGE', 'VIDEO', 'CAROUSEL', 'STORY', 'REEL', 'THREAD']).optional(),
  media: z.array(z.string()).optional(),
  scheduledFor: z.string().datetime().optional(),
  saveAsDraft: z.boolean().optional(),
  queue: z.boolean().optional(),
  firstComment: z.string().max(2200).optional(),
  firstCommentDelay: z.number().int().min(0).max(60).optional(),
  platformOverrides: z.record(z.object({
    content: z.string().optional(),
    media: z.array(z.string()).optional(),
  })).optional(),
  tags: z.array(z.string()).optional(),
  metadata: z.record(z.unknown()).optional(),
})
 
// Validate before sending
const result = CreatePostInputSchema.safeParse(inputFromUser)
if (!result.success) {
  console.error('Invalid post input:', result.error.flatten())
}