会話変数を更新

対象アプリ：Chatflow、チャットボット、Agent。

会話変数の値を更新します。新しい値は変数の既存の型と一致する必要があります。

PUT /conversations/{conversation_id}/variables/{variable_id}

会話変数を更新

cURL

curl --request PUT \
  --url https://{api_base_url}/conversations/{conversation_id}/variables/{variable_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "new value",
  "user": "abc-123"
}
'

import requests

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

payload = {
    "value": "new value",
    "user": "abc-123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: 'new value', user: 'abc-123'})
};

fetch('https://{api_base_url}/conversations/{conversation_id}/variables/{variable_id}', 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/{variable_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => 'new value',
    'user' => 'abc-123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"value\": \"new value\",\n  \"user\": \"abc-123\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{api_base_url}/conversations/{conversation_id}/variables/{variable_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"new value\",\n  \"user\": \"abc-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": \"new value\",\n  \"user\": \"abc-123\"\n}"

response = http.request(request)
puts response.read_body

200

updatedVariable

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "name": "user_preference",
  "value_type": "string",
  "value": "new value",
  "description": "ユーザー設定",
  "created_at": 1705407629,
  "updated_at": 1705411229
}

Authorizations

Authorization · string · header · required

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

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

Path Parameters

conversation_id · string<uuid> · required

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

variable_id · string<uuid> · required

更新する変数の ID です。変数 ID は 会話変数の取得 から取得します。

Body

application/json

会話変数を更新するためのリクエストボディです。

value · any · required

変数の新しい値。変数の期待される型と一致する必要があります。

user · string

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

Response

200

application/json

変数が正常に更新されました。

id · string<uuid>

Variable ID.

name · string

変数名です。

value_type · string

変数の値の型です。指定可能な値：string、number、object、secret、file、boolean、array[any]、array[string]、array[number]、array[object]、array[file]、array[boolean]。

value · string

変数値（複雑な型の場合は JSON 文字列）。

description · string

変数の説明です。

created_at · integer<int64>

作成タイムスタンプ。

updated_at · integer<int64>

最終更新タイムスタンプ。