curl --request GET \
--url https://api.example.com/api/v1/app-conversations \
--header 'X-Access-Token: <api-key>'import requests
url = "https://api.example.com/api/v1/app-conversations"
headers = {"X-Access-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};
fetch('https://api.example.com/api/v1/app-conversations', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/app-conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Access-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/app-conversations")
.header("X-Access-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/app-conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'
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": {}
}
]
}Batch Get App Conversations
Get a batch of sandboxed conversations given their ids. Return None for any missing.
Accepts UUIDs as strings (with or without dashes) and converts them internally. Returns 400 Bad Request if any string cannot be converted to a valid UUID.
curl --request GET \
--url https://api.example.com/api/v1/app-conversations \
--header 'X-Access-Token: <api-key>'import requests
url = "https://api.example.com/api/v1/app-conversations"
headers = {"X-Access-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};
fetch('https://api.example.com/api/v1/app-conversations', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/app-conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Access-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/app-conversations")
.header("X-Access-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/app-conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'
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": {}
}
]
}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?

