跳转到主要内容
PUT
/
conversations
/
{conversation_id}
/
variables
/
{variable_id}
更新对话变量
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
{ "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab", "name": "user_preference", "value_type": "string", "value": "new value", "description": "用户偏好设置", "created_at": 1705407629, "updated_at": 1705411229 }

授权

Authorization
string
header
必填

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401unauthorized)。

路径参数

conversation_id
string<uuid>
必填

变量所属的会话 ID。会话 ID 从 获取会话列表 获取。

variable_id
string<uuid>
必填

要更新的变量 ID。变量 ID 从 获取对话变量 获取。

请求体

application/json

更新会话变量的请求体。

value
any
必填

变量的新值。必须与变量的预期类型匹配。

user
string

终端用户标识,由你的应用定义,需在应用内唯一。参见 终端用户身份

响应

变量更新成功。

id
string<uuid>

Variable ID.

name
string

变量名称。

value_type
string

变量值类型。可选值:stringnumberobjectsecretfilebooleanarray[any]array[string]array[number]array[object]array[file]array[boolean]

value
string

变量值(复杂类型可以是 JSON 字符串)。

description
string

变量描述。

created_at
integer<int64>

创建时间戳。

updated_at
integer<int64>

最后更新时间戳。