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

# Get widget display configuration

> Returns the widget display and behavior settings for a brokerage.
This is called by the embedded widget on page load to apply the
brokerage's custom branding.




## OpenAPI

````yaml openapi.yaml get /v1/config
openapi: 3.1.0
info:
  title: ARIS API
  version: 1.0.0
  description: >
    The ARIS API provides programmatic access to the AI real estate assistant

    engine, MLS listing search, widget configuration, and lead management.


    ## Authentication


    All requests must include your developer API key in the `X-ARIS-API-Key`
    header.

    Obtain a key from the ARIS dashboard under **Settings → Developer Keys**.


    ```

    X-ARIS-API-Key: your-api-key

    ```


    Your API key is scoped to your brokerage. The `brokerageId` field in request

    bodies must match the brokerage associated with your key.


    ## Base URL


    ```

    https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router

    ```


    ## Rate Limits


    Requests are subject to your plan's monthly credit allowance. Each

    `/v1/chat` request consumes credits proportional to token usage. Listing

    search and config endpoints do not consume credits.


    ## Streaming


    The `/v1/chat` endpoint returns a Server-Sent Events (SSE) stream in

    OpenAI-compatible delta format. Each event is:


    ```

    data: {"choices":[{"delta":{"content":"..."},"index":0}]}

    ```


    The stream ends with:


    ```

    data: [DONE]

    ```
servers:
  - url: https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /v1/config:
    get:
      summary: Get widget display configuration
      description: |
        Returns the widget display and behavior settings for a brokerage.
        This is called by the embedded widget on page load to apply the
        brokerage's custom branding.
      operationId: getWidgetConfig
      parameters:
        - name: brokerageId
          in: query
          required: true
          schema:
            type: string
          description: The brokerage ID.
          example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: Widget configuration object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetConfig'
        '400':
          description: Missing brokerageId.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Brokerage not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    WidgetConfig:
      type: object
      description: Widget display and behavior configuration for a brokerage.
      properties:
        primaryColor:
          type: string
          example: '#1e3a8a'
        secondaryColor:
          type: string
          example: '#06b6d4'
        logoUrl:
          type: string
          format: uri
          nullable: true
        brokerageName:
          type: string
          example: Acme Realty
        greetingMessage:
          type: string
          example: Hi! How can I help you find your perfect home today?
        buttonStyle:
          type: string
          enum:
            - rounded
            - square
            - pill
          example: rounded
        chatPosition:
          type: string
          enum:
            - bottom-right
            - bottom-left
          example: bottom-right
        title:
          type: string
          example: Acme Realty Assistant
        subtitle:
          type: string
          example: here to find your next home
        buttonText:
          type: string
          example: Chat with AI
        avatarEnabled:
          type: boolean
          example: false
        avatarId:
          type: string
          nullable: true
        voiceId:
          type: string
          nullable: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
          example: brokerageId is required
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-ARIS-API-Key

````