curl --request PATCH \
--url https://api.example.com/api/v1/app-conversations/{conversation_id} \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data '
{
"title": "<string>",
"public": true,
"selected_repository": "<string>",
"selected_branch": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/app-conversations/{conversation_id}"
payload = {
"title": "<string>",
"public": True,
"selected_repository": "<string>",
"selected_branch": "<string>"
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
public: true,
selected_repository: '<string>',
selected_branch: '<string>'
})
};
fetch('https://api.example.com/api/v1/app-conversations/{conversation_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.example.com/api/v1/app-conversations/{conversation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'public' => true,
'selected_repository' => '<string>',
'selected_branch' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Token: <api-key>"
],
]);
$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.example.com/api/v1/app-conversations/{conversation_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"public\": true,\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Access-Token", "<api-key>")
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.patch("https://api.example.com/api/v1/app-conversations/{conversation_id}")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"public\": true,\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/app-conversations/{conversation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"public\": true,\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_by_user_id": "<string>",
"sandbox_id": "<string>",
"acp_server": "<string>",
"launched_agent_profile": {
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 1
},
"id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"git_provider": "github",
"title": "<string>",
"trigger": "resolver",
"pr_number": [
123
],
"llm_model": "<string>",
"agent_kind": "openhands",
"metrics": {
"model_name": "default",
"accumulated_cost": 0,
"max_budget_per_task": 123,
"accumulated_token_usage": {
"model": "",
"prompt_tokens": 0,
"completion_tokens": 0,
"cache_read_tokens": 0,
"cache_write_tokens": 0,
"reasoning_tokens": 0,
"context_window": 0,
"per_turn_token": 0,
"response_id": ""
}
},
"parent_conversation_id": "<string>",
"sub_conversation_ids": [
"<string>"
],
"public": true,
"tags": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sandbox_status": "MISSING",
"execution_status": "idle",
"conversation_url": "<string>",
"session_api_key": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update App Conversation
curl --request PATCH \
--url https://api.example.com/api/v1/app-conversations/{conversation_id} \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data '
{
"title": "<string>",
"public": true,
"selected_repository": "<string>",
"selected_branch": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/app-conversations/{conversation_id}"
payload = {
"title": "<string>",
"public": True,
"selected_repository": "<string>",
"selected_branch": "<string>"
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
public: true,
selected_repository: '<string>',
selected_branch: '<string>'
})
};
fetch('https://api.example.com/api/v1/app-conversations/{conversation_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.example.com/api/v1/app-conversations/{conversation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'public' => true,
'selected_repository' => '<string>',
'selected_branch' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Token: <api-key>"
],
]);
$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.example.com/api/v1/app-conversations/{conversation_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"public\": true,\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Access-Token", "<api-key>")
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.patch("https://api.example.com/api/v1/app-conversations/{conversation_id}")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"public\": true,\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/app-conversations/{conversation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"public\": true,\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created_by_user_id": "<string>",
"sandbox_id": "<string>",
"acp_server": "<string>",
"launched_agent_profile": {
"agent_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 1
},
"id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"git_provider": "github",
"title": "<string>",
"trigger": "resolver",
"pr_number": [
123
],
"llm_model": "<string>",
"agent_kind": "openhands",
"metrics": {
"model_name": "default",
"accumulated_cost": 0,
"max_budget_per_task": 123,
"accumulated_token_usage": {
"model": "",
"prompt_tokens": 0,
"completion_tokens": 0,
"cache_read_tokens": 0,
"cache_write_tokens": 0,
"reasoning_tokens": 0,
"context_window": 0,
"per_turn_token": 0,
"response_id": ""
}
},
"parent_conversation_id": "<string>",
"sub_conversation_ids": [
"<string>"
],
"public": true,
"tags": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sandbox_status": "MISSING",
"execution_status": "idle",
"conversation_url": "<string>",
"session_api_key": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
Request model for updating conversation metadata.
All fields are optional - only provided fields will be updated.
Response
Successful Response
Active ACP provider key ('claude-code', 'codex', 'gemini-cli'), else None.
A typed projection of the acpserver tag (same as agent-canvas) so
the conversation UI can resolve a provider brand label without a dedicated
column. Riding the tag keeps a single source of truth that
round-trips through the DB tags column for free. Gated on
agent_kind so a stray tag never reports a provider for an OpenHands
conversation.
Provenance of the Agent Profile that launched this conversation, else None.
A typed projection of the agentprofileid / agentprofilerevision
tags (same pattern as acp_server), so it round-trips through the DB
tags column for free. Canvas reads exactly
launched_agent_profile { agent_profile_id, revision }.
Show child attributes
Show child attributes
Was this page helpful?

