VoiceDock reference API

openapi: 3.1.0
info:
  title: VoiceDock reference API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 6 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; VoiceDock has published no machine-readable contract that the
    pipeline could find. Engine: oss.'
  x-evidence-tiers:
    code-example: 41
    documentation: 4
    pages-with-code: 40
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-02'
  x-generator: generate-contract-from-docs.py
  x-engine: oss
  x-sources:
  - https://doc.voicedock.ai/docs/reference/error-codes
  - https://doc.voicedock.ai/docs/reference/troubleshooting
  x-docs-section: reference
paths:
  /api/v1${endpoint}:
    get:
      operationId: get_api_v1_endpoint
      tags:
      - Api
      summary: GET /api/v1${endpoint}
      x-source: https://doc.voicedock.ai/docs/reference/error-codes
      parameters:
      - name: endpoint
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch ( `https://api.hmsovereign.com/api/v1${endpoint}` , { \n ... options, \n headers: { \n 'Authorization' : `Bearer ${API_KEY}`\
          \ , \n 'Content-Type' : 'application/json' , \n ... options.headers \n } \n })"
  /api/v1/account:
    get:
      operationId: get_api_v1_account
      tags:
      - Api
      summary: GET /api/v1/account
      x-source: https://doc.voicedock.ai/docs/reference/troubleshooting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.hmsovereign.com/api/v1/account  -H \"Authorization: Bearer fl_live_abc123...\" \n 403 Forbidden \n Symptom:\
          \ Request returns 403 Forbidden . \n Possible Causes: \n Trying to access another organization's resources \n Resource doesn't belong\
          \ to your organization \n Solution: \nVerify the resource ID belongs to your organization by listing your resources first. \n Call Issues\
          \ \n Calls Not Being"
  /api/v1/assistants/{assistantid}:
    get:
      operationId: get_api_v1_assistants_assistantid
      tags:
      - Api
      summary: GET /api/v1/assistants/{assistantId}
      x-source: https://doc.voicedock.ai/docs/reference/troubleshooting
      parameters:
      - name: assistantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.hmsovereign.com/api/v1/assistants/ASSISTANT_ID  -H \"Authorization: Bearer YOUR_API_KEY\" \n Contact your SIP\
          \ provider to verify forwarding is configured \n Calls Ending Immediately \n Symptom: Calls connect but end within seconds. \n Possible\
          \ Causes: \n Insufficient credits balance \n BYOK API keys invalid or expired \n LLM provider rate limiting \n Solution: \n Check your\
          \ credits balance: "
  /api/v1/byok:
    post:
      operationId: post_api_v1_byok
      tags:
      - Api
      summary: POST /api/v1/byok
      x-source: https://doc.voicedock.ai/docs/reference/troubleshooting
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ByokRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.hmsovereign.com/api/v1/byok  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{\"provider\": \"openai\", \"api_key\": \"sk-...\"}' \n ElevenLabs Voices Not Working \n Symptom: Assistant uses a different\
          \ voice than configured. \n Cause: The voice ID is not in your ElevenLabs Voice Library. \n Solution: \n Go to https://elevenlabs.io/app/voice-library\
          \ \n A"
  /api/v1/numbers:
    get:
      operationId: get_api_v1_numbers
      tags:
      - Api
      summary: GET /api/v1/numbers
      x-source: https://doc.voicedock.ai/docs/reference/troubleshooting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.hmsovereign.com/api/v1/numbers  -H \"Authorization: Bearer YOUR_API_KEY\" \n Check an assistant is assigned\
          \ ( assistant_id is not null) \n Verify the assistant is active: "
  /webhook:
    post:
      operationId: post_webhook
      tags:
      - Webhook
      summary: POST /webhook
      x-source: https://doc.voicedock.ai/docs/reference/troubleshooting
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWebhookRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://your-domain.com/webhook  -H \"Content-Type: application/json\"  -d '{\"test\": true}' \n Check your firewall\
          \ allows incoming POST requests \n Webhook Signature Verification Failing \n Symptom: Your signature verification always returns false.\
          \ \n Possible Causes: \n Using wrong webhook_secret \n Not using raw request body for verification \n Timestamp format mismatch \n Solution:\
          \ \n Verify "
security:
- bearer: []
components:
  schemas:
    PostApiV1ByokRequest:
      type: object
      properties:
        provider:
          type: string
        api_key:
          type: string
    PostWebhookRequest:
      type: object
      properties:
        test:
          type: boolean
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Webhook