会話の名前を変更
curl --request POST \
--url https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": "customer-001",
"name": "Refund progress",
"auto_generate": false
}
'import requests
url = "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name"
payload = {
"user": "customer-001",
"name": "Refund progress",
"auto_generate": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user: 'customer-001', name: 'Refund progress', auto_generate: false})
};
fetch('https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name', 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://{deployed_api_base_url}/v2/conversations/{conversation_id}/name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user' => 'customer-001',
'name' => 'Refund progress',
'auto_generate' => false
]),
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://{deployed_api_base_url}/v2/conversations/{conversation_id}/name"
payload := strings.NewReader("{\n \"user\": \"customer-001\",\n \"name\": \"Refund progress\",\n \"auto_generate\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": \"customer-001\",\n \"name\": \"Refund progress\",\n \"auto_generate\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": \"customer-001\",\n \"name\": \"Refund progress\",\n \"auto_generate\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "0f8fad5b-d9cb-469f-a165-70867728950e",
"name": "Refund progress",
"inputs": {
"order_id": "ORDER-1001"
},
"status": "normal",
"introduction": "Hello! I can help you check your orders.",
"created_at": 1787788800,
"updated_at": 1787788920
}
デプロイ環境
会話の名前を変更
対象アプリ:Chatflow。
会話の名前を設定します。会話の最初の質問から自動生成することもできます。
標準 API の対応する操作:会話の名前を変更。相違点は次のとおりです。
userが必須です。- エラーコードが異なります。
POST
/
v2
/
conversations
/
{conversation_id}
/
name
会話の名前を変更
curl --request POST \
--url https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": "customer-001",
"name": "Refund progress",
"auto_generate": false
}
'import requests
url = "https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name"
payload = {
"user": "customer-001",
"name": "Refund progress",
"auto_generate": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user: 'customer-001', name: 'Refund progress', auto_generate: false})
};
fetch('https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name', 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://{deployed_api_base_url}/v2/conversations/{conversation_id}/name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user' => 'customer-001',
'name' => 'Refund progress',
'auto_generate' => false
]),
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://{deployed_api_base_url}/v2/conversations/{conversation_id}/name"
payload := strings.NewReader("{\n \"user\": \"customer-001\",\n \"name\": \"Refund progress\",\n \"auto_generate\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": \"customer-001\",\n \"name\": \"Refund progress\",\n \"auto_generate\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployed_api_base_url}/v2/conversations/{conversation_id}/name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": \"customer-001\",\n \"name\": \"Refund progress\",\n \"auto_generate\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "0f8fad5b-d9cb-469f-a165-70867728950e",
"name": "Refund progress",
"inputs": {
"order_id": "ORDER-1001"
},
"status": "normal",
"introduction": "Hello! I can help you check your orders.",
"created_at": 1787788800,
"updated_at": 1787788920
}
承認
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
ボディ
application/json
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。会話の作成時に使った user と一致する必要があります。エンドユーザーの識別 を参照してください。
Required string length:
1 - 255新しい会話名です。auto_generate が true でない限り必須です。名前の保存は最大 255 バイトまでです。マルチバイト文字の長い名前は、文字の境界で切り詰めて保存され、エラーにはなりません。
Maximum string length:
255会話の最初の質問から会話名を自動生成します。true の場合、name フィールドは無視されます。自動生成した名前も同じように切り詰められます。