Get Application Parameters

GET

https://api-platform.digitpulse.ai/v1/parameters

Last modified:2025-01-13 07:48:49

Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api-platform.digitpulse.ai/v1/parameters?user' \
--header 'X-Timestamp: 1739933362' \
--header 'X-Signature: 1739933362' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Body

Example

{
    "opening_statement": "Hello!",
    "suggested_questions_after_answer": {
        "enabled": true
    },
    "speech_to_text": {
        "enabled": true
    },
    "retriever_resource": {
        "enabled": true
    },
    "annotation_reply": {
        "enabled": true
    },
    "user_input_form": [
        {
            "paragraph": {
                "label": "Query",
                "variable": "query",
                "required": true,
                "default": ""
            }
        }
    ],
    "file_upload": {
        "image": {
            "enabled": false,
            "number_limits": 3,
            "detail": "high",
            "transfer_methods": [
                "remote_url",
                "local_file"
            ]
        }
    },
    "system_parameters": {
        "file_size_limit": 15,
        "image_file_size_limit": 10,
        "audio_file_size_limit": 50,
        "video_file_size_limit": 100
    }
}

Modified at 2025-01-13 07:48:49

Get Application Information

Get Application Meta Information