> ## Documentation Index
> Fetch the complete documentation index at: https://dify-6c0370d8-docs-agent-app-service-api.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Agent App Parameters

> Retrieve Agent app input parameters. For Agent apps, the `user_input_form` field is projected from variables configured in the Agent Soul.



## OpenAPI

````yaml /en/api-reference/openapi_agent.json get /parameters
openapi: 3.0.1
info:
  title: Agent App API
  description: >-
    Agent apps expose a streaming service API for production integrations. Use
    the API key created from the Agent app API Access page. Public service API
    requests use the returned API base URL and do not include the Agent ID in
    the path; the API key identifies the backing app.
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: >-
      Base URL of the Agent App API. Use the Service API Base URL shown in the
      Agent app API Access page. For self-hosted deployments, replace it with
      your own API base URL.
    variables:
      api_base_url:
        default: api.dify.ai/v1
        description: Host and path of the API base URL, without the `https://` prefix.
security:
  - ApiKeyAuth: []
tags:
  - name: Agent Messages
    description: Send Agent app messages and stop running tasks.
  - name: Agent Files
    description: Upload files for Agent app conversations.
  - name: Agent Conversations
    description: List Agent app conversations and conversation messages.
  - name: Agent App
    description: Retrieve Agent app parameters and metadata.
paths:
  /parameters:
    get:
      tags:
        - Agent App
      summary: Get Agent App Parameters
      description: >-
        Retrieve Agent app input parameters. For Agent apps, the
        `user_input_form` field is projected from variables configured in the
        Agent Soul.
      operationId: getAgentAppParameters
      responses:
        '200':
          description: Application parameters information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAppParametersResponse'
              examples:
                appParameters:
                  summary: Response Example
                  value:
                    opening_statement: Hello! How can I help you today?
                    suggested_questions:
                      - What can you do?
                      - Tell me about your features.
                    suggested_questions_after_answer:
                      enabled: true
                    speech_to_text:
                      enabled: false
                    text_to_speech:
                      enabled: false
                      voice: alloy
                      language: en-US
                      autoPlay: disabled
                    retriever_resource:
                      enabled: true
                    annotation_reply:
                      enabled: false
                    more_like_this:
                      enabled: false
                    sensitive_word_avoidance:
                      enabled: false
                    user_input_form:
                      - text-input:
                          label: City
                          variable: city
                          required: true
                          default: ''
                    file_upload:
                      image:
                        enabled: true
                        number_limits: 3
                        detail: high
                        transfer_methods:
                          - remote_url
                          - local_file
                    system_parameters:
                      file_size_limit: 15
                      image_file_size_limit: 10
                      audio_file_size_limit: 50
                      video_file_size_limit: 100
                      workflow_file_upload_limit: 10
        '400':
          description: '`app_unavailable` : App unavailable or misconfigured.'
          content:
            application/json:
              examples:
                app_unavailable:
                  summary: app_unavailable
                  value:
                    status: 400
                    code: app_unavailable
                    message: App unavailable, please check your app configurations.
components:
  schemas:
    ChatAppParametersResponse:
      type: object
      properties:
        opening_statement:
          type: string
          description: Opening statement displayed at conversation start.
        suggested_questions:
          type: array
          items:
            type: string
          description: List of suggested starter questions.
        suggested_questions_after_answer:
          type: object
          description: Configuration for suggested questions after answer.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        speech_to_text:
          type: object
          description: Speech-to-text configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        text_to_speech:
          type: object
          description: Text-to-speech configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
            voice:
              type: string
              description: Voice identifier for TTS.
            language:
              type: string
              description: Language for TTS.
            autoPlay:
              type: string
              description: >-
                Auto-play setting. `enabled` to auto-play audio, `disabled` to
                require manual play.
        retriever_resource:
          type: object
          description: Retriever resource configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        annotation_reply:
          type: object
          description: Annotation reply configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        more_like_this:
          type: object
          description: More-like-this configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        sensitive_word_avoidance:
          type: object
          description: Sensitive word avoidance configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        user_input_form:
          type: array
          description: List of user input form elements.
          items:
            $ref: '#/components/schemas/UserInputFormItem'
        file_upload:
          type: object
          description: File upload configuration.
          properties:
            image:
              type: object
              description: Image upload settings.
              properties:
                enabled:
                  type: boolean
                  description: Whether image upload is enabled.
                number_limits:
                  type: integer
                  description: Maximum number of images.
                detail:
                  type: string
                  description: Image detail level.
                transfer_methods:
                  type: array
                  items:
                    type: string
                  description: Allowed transfer methods.
        system_parameters:
          type: object
          description: System-level parameters and limits.
          properties:
            file_size_limit:
              type: integer
              description: Maximum file size in MB.
            image_file_size_limit:
              type: integer
              description: Maximum image file size in MB.
            audio_file_size_limit:
              type: integer
              description: Maximum audio file size in MB.
            video_file_size_limit:
              type: integer
              description: Maximum video file size in MB.
            workflow_file_upload_limit:
              type: integer
              description: Maximum number of files for workflow file upload.
    UserInputFormItem:
      type: object
      oneOf:
        - $ref: '#/components/schemas/TextInputControlWrapper'
        - $ref: '#/components/schemas/ParagraphControlWrapper'
        - $ref: '#/components/schemas/SelectControlWrapper'
    TextInputControlWrapper:
      title: Text Input
      type: object
      properties:
        text-input:
          $ref: '#/components/schemas/TextInputControl'
    ParagraphControlWrapper:
      title: Paragraph
      type: object
      properties:
        paragraph:
          $ref: '#/components/schemas/ParagraphControl'
    SelectControlWrapper:
      title: Select
      type: object
      properties:
        select:
          $ref: '#/components/schemas/SelectControl'
    TextInputControl:
      type: object
      description: Text input form control.
      properties:
        label:
          type: string
          description: Display label.
        variable:
          type: string
          description: Variable name.
        required:
          type: boolean
          description: Whether input is required.
        default:
          type: string
          description: Default value.
    ParagraphControl:
      type: object
      description: Paragraph (multi-line text) form control.
      properties:
        label:
          type: string
          description: Display label.
        variable:
          type: string
          description: Variable name.
        required:
          type: boolean
          description: Whether input is required.
        default:
          type: string
          description: Default value.
    SelectControl:
      type: object
      description: Select (dropdown) form control.
      properties:
        label:
          type: string
          description: Display label.
        variable:
          type: string
          description: Variable name.
        required:
          type: boolean
          description: Whether selection is required.
        default:
          type: string
          description: Default selected value.
        options:
          type: array
          items:
            type: string
          description: List of selectable values for this form control.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API_KEY
      description: >-
        API Key authentication. For all API requests, include your API Key in
        the `Authorization` HTTP Header, prefixed with `Bearer `. Example:
        `Authorization: Bearer {API_KEY}`. **Strongly recommend storing your API
        Key on the server-side, not shared or stored on the client-side, to
        avoid possible API-Key leakage that can lead to serious consequences.**

````