Get App Parameters
Available for: Chatflow, Workflow, Agent, Chatbot, Legacy Agent, Text Generator apps.
Returns the app’s front-end configuration: the opening statement and suggested questions, feature toggles, the user input form, and file-upload limits. Use it to render the app’s inputs and apply the correct upload limits.
curl --request GET \
--url https://{api_base_url}/parameters \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/parameters"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/parameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/parameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/parameters"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/parameters")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/parameters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
},
"show_thoughts": {
"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"
}
}
]
}Authorizations
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.
Annotation reply feature configuration.
Show child attributes
Show child attributes
File upload configuration.
Show child attributes
Show child attributes
More-like-this feature configuration.
Show child attributes
Show child attributes
Opening statement text.
Knowledge retrieval citation resource configuration.
Show child attributes
Show child attributes
Content moderation feature configuration.
Show child attributes
Show child attributes
Whether the published Agent shows the model's thinking in its chat (Show thinking in Chat Features). Other app types have no such setting and return false.
For an Agent, agent_thought events carry the thinking either way; use this flag to decide whether your front end shows it.
Show child attributes
Show child attributes
Speech-to-text feature configuration.
Show child attributes
Show child attributes
List of suggested questions.
Configuration for suggested questions after an answer.
Show child attributes
Show child attributes
System-level parameter limits.
Show child attributes
Show child attributes
Text-to-speech feature configuration.
Show child attributes
Show child attributes
User input form configuration.
- Text Input
- Paragraph
- Select
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://{api_base_url}/parameters \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/parameters"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/parameters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/parameters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/parameters"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/parameters")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/parameters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
},
"show_thoughts": {
"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"
}
}
]
}