Skip to main content
get/parameters
Request example
Response
get/parameters

Authorization

Authorizationstringheaderrequired#

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).

Responses

application/json
Application parameters information.
annotation_replyobject#
Annotation reply feature configuration.
file_uploadobject#
File upload configuration.
more_like_thisobject#
More-like-this feature configuration.
opening_statementstring#
Opening statement text.
retriever_resourceobject#
Knowledge retrieval citation resource configuration.
sensitive_word_avoidanceobject#
Content moderation feature configuration.
speech_to_textobject#
Speech-to-text feature configuration.
suggested_questionsstring[]#
List of suggested questions.
suggested_questions_after_answerobject#
Configuration for suggested questions after an answer.
system_parametersobject#
System-level parameter limits.
text_to_speechobject#
Text-to-speech feature configuration.
user_input_formobject[]#
User input form configuration.