Skip to main content
GET
/
parameters
Error
A valid request URL is required to generate request examples
{
  "opening_statement": "<string>",
  "suggested_questions": [
    "<string>"
  ],
  "suggested_questions_after_answer": {
    "enabled": true
  },
  "speech_to_text": {
    "enabled": true
  },
  "text_to_speech": {
    "enabled": true,
    "voice": "<string>",
    "language": "<string>",
    "autoPlay": "enabled"
  },
  "retriever_resource": {
    "enabled": true
  },
  "annotation_reply": {
    "enabled": true
  },
  "user_input_form": [
    {
      "text-input": {
        "label": "<string>",
        "variable": "<string>",
        "required": true,
        "default": "<string>"
      }
    }
  ],
  "file_upload": {
    "image": {
      "enabled": true,
      "number_limits": 123,
      "transfer_methods": [
        "remote_url"
      ]
    }
  },
  "system_parameters": {
    "file_size_limit": 123,
    "image_file_size_limit": 123,
    "audio_file_size_limit": 123,
    "video_file_size_limit": 123
  }
}

Authorizations

​
Authorization
string
header
required

API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。

Response

200 - application/json

应用参数信息。

应用参数信息。

​
opening_statement
string

开场白。

​
suggested_questions
string[]

开场推荐问题列表。

​
suggested_questions_after_answer
object

启用回答后给出推荐问题。

​
speech_to_text
object

语音转文本。

​
text_to_speech
object

文本转语音。

​
retriever_resource
object

引用和归属。

​
annotation_reply
object

标记回复。

​
user_input_form
object[]

用户输入表单配置。

用户输入表单中的控件项。

​
file_upload
object

文件上传配置。

​
system_parameters
object

系统参数。