Rename Conversation

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
}

POST

conversations

{conversation_id}

name

Rename Conversation

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
}

Authorizations

Authorization

string

header

required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

conversation_id

string<uuid>

required

ID of the conversation to rename. Get conversation IDs from List Conversations.

Body

application/json

user

string

required

End-user identifier, defined by your app and unique within it. Must match the user the conversation was created with. See End User Identity.

Required string length: 1 - 255

name

string

New conversation name. Required unless auto_generate is true. Names are stored as at most 255 bytes. A longer name in a multi-byte script is cut at a character boundary and stored shorter, with no error.

Maximum string length: 255

auto_generate

boolean

default:false

Automatically generate the conversation name from the conversation's first question. When true, the name field is ignored. A generated name is truncated the same way.

Response

The updated conversation, with the name as stored.

string

Conversation ID.

name

string

Conversation name.

inputs

object

Input variables submitted when the conversation was created.

status

string

Always normal.

introduction

string

The app's opening statement captured when the conversation was created; an empty string when none is configured.

created_at

integer

Creation time as a Unix timestamp in seconds.

updated_at

integer

Last-update time as a Unix timestamp in seconds.

Guides

App APIs

Knowledge APIs

Rename Conversation

Authorizations

Path Parameters

Body

Response