1. BYOK
VoiceDock
  • System
    • Health check
      GET
  • Organization
    • Get organization information
      GET
    • Create organization
      POST
    • Get organization information (deprecated)
      GET
  • Assistants
    • List all assistants
      GET
    • Create a new assistant
      POST
    • Get an assistant
      GET
    • Update an assistant
      PATCH
    • Delete an assistant
      DELETE
  • Numbers
    • List all phone numbers
      GET
    • Register a phone number
      POST
    • Get a phone number
      GET
    • Update a phone number
      PATCH
    • Delete a phone number
      DELETE
  • Calls
    • List calls
      GET
    • Get call by ID
      GET
    • Initiate outbound call
      POST
  • Call Control
    • Send control command to active call
      POST
  • Usage
    • Get usage logs
      GET
  • SIP Trunks
    • List SIP trunks
    • Create a SIP trunk
    • Get a SIP trunk
    • Delete a SIP trunk
  • Voices
    • List available voices
  • BYOK
    • Get BYOK configurations
      GET
    • Add BYOK configuration
      POST
    • Delete BYOK configuration
      DELETE
    • Get BYOK provider configurations
      GET
  • Domains
    • Get your domain
    • Add a domain
    • Delete your domain
    • List available Resend domains
    • Select and sync a Resend domain
    • Verify domain DNS records
    • Refresh domain status
  • Tool Templates
    • List all tool templates
    • Create a new tool template
    • Get a tool template
    • Update a tool template
    • Delete a tool template
  • Analysis Templates
    • List analysis templates
    • Create analysis template
    • Get analysis template
    • Update analysis template
    • Delete analysis template
  • Campaigns
    • List all campaigns
    • Create a campaign
    • Get a campaign
    • Update a campaign
    • Delete a campaign
    • List campaign leads
    • Add a lead
    • Remove a lead
  • Chats
    • Append a chat message
    • List chat messages
    • Delete a chat message
    • Get conversation context for a contact
  • Webhooks
    • Dynamic assistant configuration webhook
    • Tool/Function Call
    • Call Status Update
    • End of Call Report
  • Schemas
    • OrganizationChild
    • Organization
    • Error
    • OrganizationCreate
    • OrganizationCreated
    • AnalysisPlan
    • STTConfig
    • ToolDefinition
    • LLMConfig
    • TTSConfig
    • Agent
    • AgentCreate
    • SuccessResponse
    • AgentUpdate
    • PhoneNumber
    • PhoneNumberCreate
    • PhoneNumberUpdate
    • Call
    • Pagination
    • AssistantConfigOverride
    • OutboundCallRequest
    • OutboundCallResponse
    • InjectContextCommand
    • SayCommand
    • EndCallCommand
    • TransferCommand
    • CallControlCommand
    • CallControlResponse
    • UsageLog
    • UsageSummary
    • SipTrunk
    • SipTrunkCreate
    • Voice
    • ToolTemplate
    • ToolTemplateCreate
    • ToolTemplateUpdate
    • AnalysisTemplate
    • AnalysisTemplateListResponse
    • CreateAnalysisTemplate
    • UpdateAnalysisTemplate
    • Campaign
    • CampaignCreate
    • CampaignUpdate
    • CampaignLead
    • CampaignLeadCreate
    • ChatMessage
    • ChatMessageCreate
    • ChatContext
    • CallObject
    • Customer
    • AssistantRequestPayload
    • AssistantRequestResponse
    • AssistantWebhookObject
    • ToolCall
    • ToolCallsPayload
    • ToolCallsResponse
    • StatusUpdatePayload
    • EndOfCallReportPayload
Book a meeting
Linkedin
Github
📄 Documentation🔌 API Reference
🤖 MCP📦 SDK🟢 Status
📄 Documentation🔌 API Reference
🤖 MCP📦 SDK🟢 Status
  1. BYOK

Get BYOK configurations

GET
https://api.hmsovereign.com/api/v1/byok
BYOK
Last modified:2026-05-04 13:09:49
Maintainer:Not configured
Retrieve all Bring Your Own Key configurations for your organization.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or

Responses

🟢200OK
application/json
List of BYOK configurations
Body

🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.hmsovereign.com/api/v1/byok' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "byok_keys": {
        "deepgram_secret_id": "string",
        "openai_secret_id": "string",
        "elevenlabs_secret_id": "string",
        "resend_secret_id": "string",
        "xai_secret_id": "string",
        "gladia_secret_id": "string",
        "mistral_secret_id": "string"
    }
}
Modified at 2026-05-04 13:09:49
Previous
List available voices
Next
Add BYOK configuration
Built with