ShortVox Docs

API Documentation

Welcome to the ShortVox API. This guide explains authentication, scopes, core endpoints, and integration patterns for Business customers.

Base URL

API version 1 is available at:

https://shortvox.com/api/v1

Authentication

Use a Business API key in the bearer header. Generate keys from dashboard settings. Keys can be rotated and revoked at any time.

Authorization: Bearer svx_live_your_key_here

Scopes

jobs:read - read job lists and job details

jobs:write - create and delete jobs

* - full API access

Core Endpoints

GET /jobs (scope: jobs:read)

curl -X GET "https://shortvox.com/api/v1/jobs?page=1&limit=20" \
  -H "Authorization: Bearer svx_live_your_key_here"

POST /jobs (scope: jobs:write)

curl -X POST "https://shortvox.com/api/v1/jobs" \
  -H "Authorization: Bearer svx_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "videoId": "11111111-1111-1111-1111-111111111111",
    "style": "hype",
    "subtitleStyle": "clean_white"
  }'

GET /jobs/:id (scope: jobs:read)

curl -X GET "https://shortvox.com/api/v1/jobs/22222222-2222-2222-2222-222222222222" \
  -H "Authorization: Bearer svx_live_your_key_here"

DELETE /jobs/:id (scope: jobs:write)

curl -X DELETE "https://shortvox.com/api/v1/jobs/22222222-2222-2222-2222-222222222222" \
  -H "Authorization: Bearer svx_live_your_key_here"

Errors & Rate Limits

400 invalid request payload or malformed JSON

401 missing, invalid, or revoked API key

403 missing scope or inactive Business entitlement

404 resource not found

429 key rate limit, monthly quota, or concurrency limit reached

OpenAPI

Import this spec into Postman or Insomnia:

/api/v1/openapi.json