> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendora.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get widget configuration

> Rendering config for a website voice-call widget. Origin-allowlisted;
never exposes workspace identifier/agent_id/connected service_agent_id.



## OpenAPI

````yaml /openapi.json get /api/v1/public/widget/{widget_public_id}/config
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Build, launch, pause and stop campaigns, and enroll leads.
    name: Campaigns
  - description: Create, update, tag, enrich and import leads.
    name: Leads
  - description: Group leads into reusable lists.
    name: Lead lists
  - description: Find new prospects and research existing leads.
    name: Prospecting
  - description: Read conversations and send messages to leads.
    name: Inbox
  - description: Manage workspace-wide suppressions.
    name: Do not contact
  - description: Manage the content your agents answer from.
    name: Knowledge bases
  - description: Create, configure, test and publish voice agents.
    name: Voice agents
  - description: Give agents actions such as booking, lookups and transfers.
    name: Agent tools
  - description: Embed a voice agent on your website.
    name: Voice widgets
  - description: Start voice calls and read call results.
    name: Calls
  - description: Browse and preview the voices an agent can use.
    name: Voices
  - description: List numbers, bring your own, and route calls.
    name: Phone numbers
  - description: List the channel accounts connected to the workspace.
    name: Connected accounts
  - description: Register endpoints and review deliveries.
    name: Webhooks
  - description: Drive the workspace assistant programmatically.
    name: Copilot
  - description: Read workspace and campaign performance.
    name: Analytics
  - description: Track asynchronous operations.
    name: Jobs
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/widget/{widget_public_id}/config:
    get:
      tags:
        - Voice widgets
      summary: Get widget configuration
      description: |-
        Rendering config for a website voice-call widget. Origin-allowlisted;
        never exposes workspace identifier/agent_id/connected service_agent_id.
      operationId: get_widget_config_api_v1_public_widget__widget_public_id__config_get
      parameters:
        - description: >-
            The widget's public id, taken from its embed code (Get widget embed
            code).
          in: path
          name: widget_public_id
          required: true
          schema:
            title: Widget Public Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetPublicConfigOut'
          description: Successful Response
        '402':
          description: The workspace is not currently eligible for this billable operation.
        '403':
          description: >-
            The key is valid but the workspace lacks the required entitlement,
            or a widget origin is not allowed.
        '404':
          description: >-
            The resource does not exist or is not owned by the authenticated
            workspace.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '429':
          description: The operation is rate limited. Respect Retry-After before retrying.
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            The operation is temporarily unavailable. Retry with backoff when
            safe.
      security: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X GET
            'https://api.sendora.ai/api/v1/public/widget/YOUR_ID/config'
        - label: Python
          lang: python
          source: |-
            import requests

            url = 'https://api.sendora.ai/api/v1/public/widget/YOUR_ID/config'
            headers = {}
            response = requests.get(url, headers=headers)
            response.raise_for_status()
            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/widget/YOUR_ID/config",
            {
              method: "GET",
              headers: {  },
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("GET",
            "https://api.sendora.ai/api/v1/public/widget/YOUR_ID/config", nil)

            if err != nil { log.Fatal(err) }

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    WidgetPublicConfigOut:
      description: >-
        Everything a browser needs to render the widget. Never includes

        workspace identifier, agent_id, connected service_agent_id, or anything
        else internal.
      properties:
        avatar_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Avatar url returned by the Sendora API.
          title: Avatar Url
        avatar_video_live_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Avatar video live url returned by the Sendora API.
          title: Avatar Video Live Url
        avatar_video_pre_call_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Avatar video pre call url returned by the Sendora API.
          title: Avatar Video Pre Call Url
        avatar_video_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Avatar video url returned by the Sendora API.
          title: Avatar Video Url
        consent_text:
          description: Consent text returned by the Sendora API.
          title: Consent Text
          type: string
        display_mode:
          default: conversation
          description: Display mode returned by the Sendora API.
          enum:
            - conversation
            - compact
            - launcher
          title: Display Mode
          type: string
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Display name returned by the Sendora API.
          title: Display Name
        greeting_text:
          description: Greeting text returned by the Sendora API.
          title: Greeting Text
          type: string
        launcher_icon:
          default: iridescent
          description: Launcher icon returned by the Sendora API.
          title: Launcher Icon
          type: string
        launcher_media_type:
          anyOf:
            - enum:
                - image
                - video
              type: string
            - type: 'null'
          description: Launcher media type returned by the Sendora API.
          title: Launcher Media Type
        launcher_media_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Launcher media url returned by the Sendora API.
          title: Launcher Media Url
        name:
          description: Name returned by the Sendora API.
          title: Name
          type: string
        position:
          description: Position returned by the Sendora API.
          title: Position
          type: string
        pre_call_form:
          description: Pre call form returned by the Sendora API.
          items:
            additionalProperties: true
            type: object
          title: Pre Call Form
          type: array
        public_id:
          description: The widget's public id, used in its embed code.
          title: Public Id
          type: string
        require_consent:
          description: Require consent returned by the Sendora API.
          title: Require Consent
          type: boolean
        settings:
          $ref: >-
            #/components/schemas/api__v1__public__widget__schemas__WidgetEditorSettings
          description: Settings returned by the Sendora API.
        show_transcript:
          description: Show transcript returned by the Sendora API.
          title: Show Transcript
          type: boolean
        theme:
          additionalProperties: true
          description: Theme returned by the Sendora API.
          title: Theme
          type: object
      required:
        - public_id
        - name
        - position
        - theme
        - greeting_text
        - consent_text
        - require_consent
        - pre_call_form
        - show_transcript
      title: WidgetPublicConfigOut
      type: object
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    api__v1__public__widget__schemas__WidgetEditorSettings:
      properties:
        accent_color:
          default: '#18181b'
          description: Accent color returned by the Sendora API.
          maxLength: 32
          title: Accent Color
          type: string
        auto_create_contact:
          default: true
          description: Auto create contact returned by the Sendora API.
          title: Auto Create Contact
          type: boolean
        auto_open:
          default: never
          description: Auto open returned by the Sendora API.
          enum:
            - never
            - delay
            - scroll
            - exit-intent
          title: Auto Open
          type: string
        auto_open_delay_seconds:
          default: 5
          description: Auto open delay seconds returned by the Sendora API.
          maximum: 120
          minimum: 1
          title: Auto Open Delay Seconds
          type: integer
        capture_device:
          default: false
          description: Capture device returned by the Sendora API.
          title: Capture Device
          type: boolean
        capture_referrer:
          default: true
          description: Capture referrer returned by the Sendora API.
          title: Capture Referrer
          type: boolean
        capture_timezone:
          default: true
          description: Capture timezone returned by the Sendora API.
          title: Capture Timezone
          type: boolean
        capture_utm:
          default: true
          description: Capture utm returned by the Sendora API.
          title: Capture Utm
          type: boolean
        close_behavior:
          default: manual
          description: Close behavior returned by the Sendora API.
          enum:
            - manual
            - outside-click
          title: Close Behavior
          type: string
        contact_match:
          default: email-or-phone
          description: Contact match returned by the Sendora API.
          enum:
            - email
            - phone
            - email-or-phone
          title: Contact Match
          type: string
        cta_label:
          default: Start call
          description: Cta label returned by the Sendora API.
          maxLength: 80
          title: Cta Label
          type: string
        font:
          default: system
          description: Font returned by the Sendora API.
          enum:
            - system
            - cal-sans
          title: Font
          type: string
        mobile_behavior:
          default: responsive
          description: Mobile behavior returned by the Sendora API.
          enum:
            - responsive
            - full-screen
            - launcher
          title: Mobile Behavior
          type: string
        primary_color:
          default: '#17191D'
          description: Primary color returned by the Sendora API.
          maxLength: 32
          title: Primary Color
          type: string
        privacy_policy_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Privacy policy url returned by the Sendora API.
          title: Privacy Policy Url
        radius:
          default: rounded
          description: Radius returned by the Sendora API.
          enum:
            - subtle
            - rounded
            - pill
          title: Radius
          type: string
        separate_videos:
          default: false
          description: Separate videos returned by the Sendora API.
          title: Separate Videos
          type: boolean
        shadow:
          default: soft
          description: Shadow returned by the Sendora API.
          enum:
            - none
            - soft
            - elevated
          title: Shadow
          type: string
        show_end:
          default: true
          description: Show end returned by the Sendora API.
          title: Show End
          type: boolean
        show_mute:
          default: true
          description: Show mute returned by the Sendora API.
          title: Show Mute
          type: boolean
        show_status:
          default: true
          description: Show status returned by the Sendora API.
          title: Show Status
          type: boolean
        size:
          default: medium
          description: Size returned by the Sendora API.
          enum:
            - small
            - medium
            - large
          title: Size
          type: string
        terms_url:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: Terms url returned by the Sendora API.
          title: Terms Url
        update_existing_contact:
          default: true
          description: Update existing contact returned by the Sendora API.
          title: Update Existing Contact
          type: boolean
      required: []
      title: WidgetEditorSettings
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.