メインコンテンツへスキップ
GET
/
conversations
/
{conversation_id}
/
variables
会話変数の取得
curl --request GET \
  --url https://{api_base_url}/conversations/{conversation_id}/variables \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{api_base_url}/conversations/{conversation_id}/variables"

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}/conversations/{conversation_id}/variables', 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}/conversations/{conversation_id}/variables",
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}/conversations/{conversation_id}/variables"

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}/conversations/{conversation_id}/variables")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/conversations/{conversation_id}/variables")

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
{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "name": "user_preference",
      "value_type": "string",
      "value": "dark_mode",
      "description": "ユーザー設定",
      "created_at": 1705407629,
      "updated_at": 1705411229
    }
  ]
}

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

パスパラメータ

conversation_id
string
必須

変数を一覧表示する会話の ID です。会話 ID は 会話一覧を取得 から取得します。

クエリパラメータ

user
string

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。エンドユーザーの識別 を参照してください。

last_id
string

ページネーションカーソルです。現在のページの最後の変数の id を指定します。省略すると最初のページを取得します。

limit
integer
デフォルト:20

返すレコード数です。

必須範囲: 1 <= x <= 100
variable_name
string

指定した名前で変数をフィルタリングします。

Required string length: 1 - 255

レスポンス

会話変数の取得に成功しました。

limit
integer

1 ページあたりの件数です。

has_more
boolean

次のページがあるかどうかです。

data
object[]

会話変数のリストです。