Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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.

Response

Application parameters information.

opening_statement
string

Opening statement displayed at start.

suggested_questions
string[]

List of suggested starter questions.

suggested_questions_after_answer
object

Configuration for suggested questions after answer.

speech_to_text
object

Speech-to-text configuration.

text_to_speech
object

Text-to-speech configuration.

retriever_resource
object

Retriever resource configuration.

annotation_reply
object

Annotation reply configuration.

more_like_this
object

More-like-this configuration.

sensitive_word_avoidance
object

Sensitive word avoidance configuration.

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

List of user input form elements.

file_upload
object

File upload configuration.

system_parameters
object

System-level parameters and limits.