Get App Parameters | Dify Octri Demo

2 status codes

200Application parameters information.

annotation_replyobjectoptional

Annotation reply feature configuration.

file_uploadobjectoptional

File upload configuration.

more_like_thisobjectoptional

More-like-this feature configuration.

opening_statementstringoptional

Opening statement text.

retriever_resourceobjectoptional

Knowledge retrieval citation resource configuration.

sensitive_word_avoidanceobjectoptional

Content moderation feature configuration.

speech_to_textobjectoptional

Speech-to-text feature configuration.

suggested_questionsarray<string>optional

List of suggested questions.

suggested_questions_after_answerobjectoptional

Configuration for suggested questions after an answer.

system_parametersobjectoptional

System-level parameter limits.

text_to_speechobjectoptional

Text-to-speech feature configuration.

user_input_formarray<TextInput>optional

User input form configuration.

400- `app_unavailable` : The app is unavailable or misconfigured. - `agent_not_published` : The app's Agent has no published version yet. (Agent apps)

2 documented failures

agent_not_published
Agent has not been published. Please publish the Agent before using the API.
agent_not_published
app_unavailable
App unavailable, please check your app configurations.
app_unavailable

Error handling

A 400 is returned: - app_unavailable : The app is unavailable or misconfigured.

agent_not_published : The app's Agent has no published version yet. (Agent apps).

import { Client } from "dify-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{api_base_url}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.parameters.list();

{
  "annotation_reply": {
    "enabled": false
  },
  "file_upload": {
    "image": {
      "detail": "high",
      "enabled": true,
      "number_limits": 3,
      "transfer_methods": [
        "remote_url",
        "local_file"
      ]
    }
  },
  "more_like_this": {
    "enabled": false
  },
  "opening_statement": "Hello! How can I help you today?",
  "retriever_resource": {
    "enabled": true
  },
  "sensitive_word_avoidance": {
    "enabled": false
  },
  "speech_to_text": {
    "enabled": false
  },
  "suggested_questions": [
    "What can you do?",
    "Tell me about your features."
  ],
  "suggested_questions_after_answer": {
    "enabled": true
  },
  "system_parameters": {
    "audio_file_size_limit": 50,
    "file_size_limit": 15,
    "image_file_size_limit": 10,
    "video_file_size_limit": 100,
    "workflow_file_upload_limit": 10
  },
  "text_to_speech": {
    "autoPlay": "disabled",
    "enabled": false,
    "language": "en-US",
    "voice": "alloy"
  },
  "user_input_form": [
    {
      "text-input": {
        "default": "",
        "label": "City",
        "required": true,
        "variable": "city"
      }
    }
  ]
}

Response

Errors