봇에서 전역 및 콘텐츠 변수를 내보냅니다.

이 API를 사용하려면 앱에 변수 내보내기의 봇 빌더 API 범위가 필요합니다.

POSThttps://{{host}}/api/{{version}}/public/builder/stream/{{BotID}}/variables/export

쿼리 매개 변수

매개 변수	설명
host	환경 URL(예: https://bots.kore.ai)
BotID	봇 ID입니다. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/JSON

샘플 요청

curl -X POST \
  https://{{host}}/api/1.1/public/builder/stream/{{BotId}}/variables/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

샘플 응답

[
    {
        "key": "Global",
        "value": "Globalkey-prePopulated",
        "hint": "",
        "variableType": "env",
        "scope": "prePopulated"
    },
    {
        "key": "Lang",
        "variableType": "locale",
        "scope": "prePopulated",
        "localeData": {
            "en": {
                "value": "english language prompt",
                "hint": ""
            }
        }
    }
]

グローバル変数とコンテンツ変数をボットからエクスポートします。

このAPIを使用するためには、アプリに変数のエクスポートのボットビルダーAPIスコープが必要となります。

POST https://{{host}}/api/{{version}}/public/builder/stream/{{BotID}}/variables/export

クエリパラメータ

パラメータ	説明
host	環境URL、例： https://bots.kore.ai
BotID	ボットID。ボットの「一般設定」ページからアクセスできます。

認証

ヘッダー内のJWTを含むAPIを、以下の構文で呼び出します。 auth: {{JWT}}

応答コンテンツタイプ

application/JSON

サンプルのリクエスト

curl -X POST \
  https://{{host}}/api/1.1/public/builder/stream/{{BotId}}/variables/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプルのレスポンス

[
    {
        "key": "Global",
        "value": "Globalkey-prePopulated",
        "hint": "",
        "variableType": "env",
        "scope": "prePopulated"
    },
    {
        "key": "Lang",
        "variableType": "locale",
        "scope": "prePopulated",
        "localeData": {
            "en": {
                "value": "english language prompt",
                "hint": ""
            }
        }
    }
]

Exports global and content variables from a bot.

To use this API, app needs the Bot Builder API scope of Export Variables.

POST https://{{host}}/api/{{version}}/public/builder/stream/{{BotID}}/variables/export

Query Parameters

Parameter	Description
host	Environment URL, for example, https://bots.kore.ai
BotID	Bot ID. You can access it from the General Settings page of the bot.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/JSON

Sample Request

curl -X POST \
  https://{{host}}/api/1.1/public/builder/stream/{{BotId}}/variables/export \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

[
    {
        "key": "Global",
        "value": "Globalkey-prePopulated",
        "hint": "",
        "variableType": "env",
        "scope": "prePopulated"
    },
    {
        "key": "Lang",
        "variableType": "locale",
        "scope": "prePopulated",
        "localeData": {
            "en": {
                "value": "english language prompt",
                "hint": ""
            }
        }
    }
]