Skip to content
First requestVisit website ↗
Navigation

Patch shared keys without modifying any agent script

Requires workspace owner, admin or manager. No page-load initialization. Creation requires capability version 1 from voice_service, ingest_worker and trigger.

PUT
https://api.channelautomation.com/api/workspaces/{workspaceId}/voice-ai/settings/shared

Authorization

  • BearerAuth
    HTTP Bearer (JWT)
    required

Path parameters

  • workspaceId
    string
    required

Request body JSON required

  • base_revision
    optional
    integer
    minimum: 0
  • apiKey
    optional
    string
  • enabled
    optional
    boolean
  • inbound_enabled
    optional
    boolean
  • outbound_enabled
    optional
    boolean
  • max_concurrent_calls
    optional
    integer
    maximum: 100 · minimum: 1
  • outbound_share_percent
    optional
    integer

    Outbound share of total workspace capacity. At least one inbound slot remains when the total is two or more.

    maximum: 100 · minimum: 10 · default: 70
  • inbound_hours
    optional
    object

    Team hours and team_ring_seconds (10 through 60)

  • turn_detection_mode
    optional
    server_vad
    or
    semantic_vad

Returns

200

Successful response with masked settings

JSON
  • success
    optional
    boolean
  • agent
    optional
    object

    Profile metadata and name without voice_config or credentials

  • legacy
    optional
    boolean

    True until profiles have been explicitly created

  • uses_builtin
    optional
    boolean

    True when an OpenAI voice_ai block or profiles exist; controls the built-in fleet and tour

  • agents
    optional
    array of
    object

    Without profiles the latest legacy voice row is returned. A built-in config without a pointer returns a legacy entry with null agent_id that opens workspace settings without initialization.

  • config
    optional
    object

    Normalized settings with credential configured booleans

400

Invalid request or unavailable agent

401

Authentication required

403

Workspace admin or manager required

404

Agent not found

409

Stale revision

500

Service error

503

Migration or consumer capabilities unavailable

Type to search…

↑↓ navigate↵ selectEsc close