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

# List supported connection options

> List the connection options supported by this server. Use each option’s fields and credentialFields to configure an agent connection. This catalog does not check provider accounts or deployment credentials.



## OpenAPI

````yaml openapi.json GET /v1/connection-options
openapi: 3.1.0
info:
  title: Egma Platform API
  version: 1.0.0
  description: >-
    The customer-facing HTTP interface used by Egma's web app, CLI, and outside
    clients.
servers:
  - url: https://app.egma.ai
security: []
paths:
  /v1/connection-options:
    get:
      tags:
        - Connections
      summary: List supported connection options
      description: >-
        List the connection options supported by this server. Use each option’s
        fields and credentialFields to configure an agent connection. This
        catalog does not check provider accounts or deployment credentials.
      operationId: listConnectionOptions
      responses:
        '200':
          description: The server-owned connection option catalog.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        agentPlatform:
                          anyOf:
                            - type: string
                              enum:
                                - retell
                                - livekit
                            - type: 'null'
                        agentPlatformLabel:
                          type: string
                        connectionType:
                          type: string
                          enum:
                            - retell_text_mode
                            - retell_web_call
                            - phone_number
                            - livekit_room
                        accessVariant:
                          type: string
                          enum:
                            - retell_text_mode.api_key
                            - retell_web_call.api_key
                            - phone_number.public_e164
                            - livekit_room.project_credentials
                            - livekit_room.customer_token_endpoint
                        accessVariantLabel:
                          type: string
                        modality:
                          type: string
                          enum:
                            - voice
                            - chat
                        productLabel:
                          type: string
                        topology:
                          type: string
                          enum:
                            - agent-dials-out
                            - hosted-broker
                            - egma-dials-in
                        simulatorAdapter:
                          type: boolean
                        fields:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: >-
                                  Property name to include in the connection
                                  request's config object.
                              label:
                                type: string
                              kind:
                                type: string
                                enum:
                                  - text
                                  - url
                                  - e164
                                  - json
                              required:
                                type: boolean
                                description: >-
                                  Whether this config field must be supplied for
                                  the selected option.
                              help:
                                type: string
                              afterCredentials:
                                type: boolean
                                description: >-
                                  Whether provider credentials are needed before
                                  the setup flow can resolve choices for this
                                  field.
                            required:
                              - key
                              - label
                              - kind
                              - required
                              - help
                              - afterCredentials
                            additionalProperties: false
                        credentialRule:
                          type: string
                          enum:
                            - required
                            - forbidden
                            - optional
                          description: >-
                            Whether the connection stores credentials for this
                            access variant. Retell phone setup can still need an
                            agent-level provider key to confirm the phone route.
                        credentialHelp:
                          type: string
                        credentialFields:
                          type: array
                          items:
                            type: object
                            properties:
                              field:
                                type: string
                                description: >-
                                  Property name in the connection request's
                                  credentials object.
                              label:
                                type: string
                              kind:
                                type: string
                                enum:
                                  - secret
                                  - json
                                description: >-
                                  Input type. JSON credential values such as
                                  headers are encoded as strings containing
                                  JSON.
                              required:
                                type: boolean
                                description: >-
                                  Whether this credential field is required for
                                  the selected option.
                              help:
                                type: string
                            required:
                              - field
                              - label
                              - kind
                              - required
                              - help
                            additionalProperties: false
                      required:
                        - agentPlatform
                        - agentPlatformLabel
                        - connectionType
                        - accessVariant
                        - accessVariantLabel
                        - modality
                        - productLabel
                        - topology
                        - simulatorAdapter
                        - fields
                        - credentialRule
                        - credentialHelp
                        - credentialFields
                      additionalProperties: false
                required:
                  - items
                additionalProperties: false
        '401':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '429':
          description: The request rate limit was reached.
          headers:
            Retry-After:
              description: Seconds to wait before trying again.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Refusal:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
      required:
        - error
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Egma API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: egma.session_token
      description: >-
        The browser session cookie issued by Egma. HTTPS deployments add the
        standard __Secure- prefix.

````