Skip to main content
GET
Get App Parameters

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Response

Application parameters information.

opening_statement
string | null

Opening statement text.

suggested_questions
string[]

List of suggested questions.

suggested_questions_after_answer
object

Configuration for suggested questions after an answer.

speech_to_text
object

Speech-to-text feature configuration.

text_to_speech
object

Text-to-speech feature configuration.

retriever_resource
object

Knowledge retrieval citation resource configuration.

annotation_reply
object

Annotation reply feature configuration.

more_like_this
object

More-like-this feature configuration.

sensitive_word_avoidance
object

Content moderation feature configuration.

user_input_form
(Text Input · object | Paragraph · object | Select · object)[]

User input form configuration.

file_upload
object

File upload configuration.

system_parameters
object

System-level parameter limits.