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

# Get App Parameters

> **Available for**: Chatflow, Workflow, New Agent, Chatbot, Agent, Text Generator apps.

Retrieve the application's input form configuration, including feature switches, input parameter names, types, and default values.



## OpenAPI

````yaml /en/api-reference/openapi_service.json get /parameters
openapi: 3.0.1
info:
  title: Dify Service API
  description: >-
    REST API for Dify applications and knowledge bases. Application endpoints
    authenticate with an app API key; knowledge endpoints authenticate with a
    dataset API key.
  version: 1.0.0
servers:
  - url: https://{api_base_url}
    description: >-
      Base URL of the Dify Service API. 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: Chat Messages
    description: Operations related to chat messages and interactions.
  - name: Files
    description: File upload and preview operations.
  - name: End Users
    description: Operations related to end user information.
  - name: Feedback
    description: User feedback operations.
  - name: Conversations
    description: Operations related to managing conversations.
  - name: Audio
    description: Text-to-Speech and Speech-to-Text operations.
  - name: Applications
    description: Operations to retrieve application settings and information.
  - name: Annotations
    description: Operations related to managing annotations for direct replies.
  - name: Human Input
    description: Endpoints for resuming paused workflows that require human input.
  - name: Workflow Runs
    description: Operations for executing and managing workflows.
  - name: Completion Messages
    description: Operations related to text generation and completion.
  - name: Knowledge Bases
    description: >-
      Operations for managing knowledge bases, including creation,
      configuration, and retrieval.
  - name: Documents
    description: >-
      Operations for creating, updating, and managing documents within a
      knowledge base.
  - name: Chunks
    description: Operations for managing document chunks and child chunks.
  - name: Metadata
    description: >-
      Operations for managing knowledge base metadata fields and document
      metadata values.
  - name: Tags
    description: Operations for managing knowledge base tags and tag bindings.
  - name: Models
    description: Operations for retrieving available models.
  - name: Knowledge Pipeline
    description: >-
      Operations for managing and running knowledge pipelines, including
      datasource plugins and pipeline execution.
paths:
  /parameters:
    get:
      tags:
        - Applications
      summary: Get App Parameters
      description: >-
        **Available for**: Chatflow, Workflow, New Agent, Chatbot, Agent, Text
        Generator apps.


        Retrieve the application's input form configuration, including feature
        switches, input parameter names, types, and default values.
      operationId: getChatAppParameters
      responses:
        '200':
          description: Application parameters information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppParametersResponse'
              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.

            - `agent_not_published` : The bound Agent has no published version.
            (New Agent apps)
          content:
            application/json:
              examples:
                app_unavailable:
                  summary: app_unavailable
                  value:
                    status: 400
                    code: app_unavailable
                    message: App unavailable, please check your app configurations.
                agent_not_published:
                  summary: agent_not_published
                  value:
                    code: agent_not_published
                    message: >-
                      Agent has not been published. Please publish the Agent
                      before using the API.
                    status: 400
components:
  schemas:
    AppParametersResponse:
      type: object
      properties:
        opening_statement:
          type: string
          nullable: true
          description: Opening statement text.
        suggested_questions:
          type: array
          items:
            type: string
          description: List of suggested questions.
        suggested_questions_after_answer:
          type: object
          description: Configuration for suggested questions after an answer.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        speech_to_text:
          type: object
          description: Speech-to-text feature configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        text_to_speech:
          type: object
          description: Text-to-speech feature 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: Knowledge retrieval citation resource configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        annotation_reply:
          type: object
          description: Annotation reply feature configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        more_like_this:
          type: object
          description: More-like-this feature configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        sensitive_word_avoidance:
          type: object
          description: Content moderation feature configuration.
          properties:
            enabled:
              type: boolean
              description: Whether this feature is enabled.
        user_input_form:
          type: array
          items:
            type: object
            oneOf:
              - title: Text Input
                type: object
                properties:
                  text-input:
                    type: object
                    properties:
                      label:
                        type: string
                        description: Display label for the input field.
                      variable:
                        type: string
                        description: Variable name used in the workflow.
                      required:
                        type: boolean
                        description: Whether this field is required.
                      default:
                        type: string
                        description: Default value for the input field.
              - title: Paragraph
                type: object
                properties:
                  paragraph:
                    type: object
                    properties:
                      label:
                        type: string
                        description: Display label for the paragraph field.
                      variable:
                        type: string
                        description: Variable name used in the workflow.
                      required:
                        type: boolean
                        description: Whether this field is required.
                      default:
                        type: string
                        description: Default value for the paragraph field.
              - title: Select
                type: object
                properties:
                  select:
                    type: object
                    properties:
                      label:
                        type: string
                        description: Display label for the select field.
                      variable:
                        type: string
                        description: Variable name used in the workflow.
                      required:
                        type: boolean
                        description: Whether this field is required.
                      default:
                        type: string
                        description: Default selected value.
                      options:
                        type: array
                        items:
                          type: string
                        description: List of selectable values for this form control.
          description: User input form configuration.
        file_upload:
          type: object
          description: File upload configuration.
          properties:
            image:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Whether image upload is enabled.
                number_limits:
                  type: integer
                  description: Maximum number of images that can be uploaded.
                detail:
                  type: string
                  description: Image detail level for vision models.
                transfer_methods:
                  type: array
                  items:
                    type: string
                  description: >-
                    Allowed transfer methods for image upload. `remote_url` for
                    file URL, `local_file` for uploaded file.
        system_parameters:
          type: object
          description: System-level parameter limits.
          properties:
            file_size_limit:
              type: integer
              description: Maximum general 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 per workflow execution.
  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.**
        Requests with a missing or invalid API key fail with HTTP `401` and
        error code `unauthorized`.

````