> ## Documentation Index
> Fetch the complete documentation index at: https://allhandsai-chore-regenerate-agent-sdk-openapi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Conversation Settings Schema

> Return the schema used to render ConversationSettings-based forms.



## OpenAPI

````yaml /openapi/agent-sdk.json get /api/settings/conversation-schema
openapi: 3.1.0
info:
  description: OpenHands Agent Server - REST/WebSocket interface for OpenHands AI Agent
  title: OpenHands Agent Server
  version: 1.52.0
servers: []
security: []
paths:
  /api/settings/conversation-schema:
    get:
      tags:
        - Settings
      summary: Get Conversation Settings Schema
      description: Return the schema used to render ConversationSettings-based forms.
      operationId: get_conversation_settings_schema_api_settings_conversation_schema_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsSchema'
          description: Successful Response
      security:
        - APIKeyHeader: []
components:
  schemas:
    SettingsSchema:
      properties:
        model_name:
          title: Model Name
          type: string
        sections:
          items:
            $ref: '#/components/schemas/SettingsSectionSchema'
          title: Sections
          type: array
      required:
        - model_name
        - sections
      title: SettingsSchema
      type: object
    SettingsSectionSchema:
      properties:
        fields:
          items:
            $ref: '#/components/schemas/SettingsFieldSchema'
          title: Fields
          type: array
        key:
          title: Key
          type: string
        label:
          title: Label
          type: string
        variant:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When set, this section only applies to the named ``AgentSettings``
            variant (e.g. ``'openhands'`` or ``'acp'``). The GUI filters
            sections by the current ``agent_kind`` value; sections with
            ``variant=None`` are always shown.
          title: Variant
      required:
        - key
        - label
        - fields
      title: SettingsSectionSchema
      type: object
    SettingsFieldSchema:
      properties:
        choices:
          items:
            $ref: '#/components/schemas/SettingsChoice'
          title: Choices
          type: array
        default:
          title: Default
        depends_on:
          items:
            type: string
          title: Depends On
          type: array
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        key:
          title: Key
          type: string
        label:
          title: Label
          type: string
        prominence:
          $ref: '#/components/schemas/SettingProminence'
          default: minor
        secret:
          default: false
          title: Secret
          type: boolean
        section:
          title: Section
          type: string
        section_label:
          title: Section Label
          type: string
        value_type:
          enum:
            - string
            - integer
            - number
            - boolean
            - array
            - object
          title: Value Type
          type: string
        variant:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When set, the field only applies to the named ``AgentSettings``
            variant (``'openhands'`` or ``'acp'``). The GUI filters fields by
            the user's current variant; fields with ``variant=None`` are shown
            regardless.
          title: Variant
      required:
        - key
        - label
        - section
        - section_label
        - value_type
      title: SettingsFieldSchema
      type: object
    SettingsChoice:
      properties:
        label:
          title: Label
          type: string
        value:
          anyOf:
            - type: boolean
            - type: integer
            - type: number
            - type: string
          title: Value
      required:
        - value
        - label
      title: SettingsChoice
      type: object
    SettingProminence:
      enum:
        - critical
        - major
        - minor
      title: SettingProminence
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-Session-API-Key
      type: apiKey

````

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