Search App Conversations

curl --request GET \
  --url https://api.example.com/api/v1/app-conversations/search \
  --header 'X-Access-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://api.example.com/api/v1/app-conversations/search', 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/search",
  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/search"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/app-conversations/search")

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

{
  "items": [
    {
      "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>",
      "title": "<string>",
      "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",
      "conversation_url": "<string>",
      "session_api_key": "<string>"
    }
  ],
  "next_page_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

api

app-conversations

Search App Conversations

curl --request GET \
  --url https://api.example.com/api/v1/app-conversations/search \
  --header 'X-Access-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://api.example.com/api/v1/app-conversations/search', 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/search",
  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/search"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/app-conversations/search")

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

{
  "items": [
    {
      "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>",
      "title": "<string>",
      "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",
      "conversation_url": "<string>",
      "session_api_key": "<string>"
    }
  ],
  "next_page_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-Access-Token

string

header

required

Query Parameters

title__contains

string | null

created_at__gte

string<date-time> | null

created_at__lt

string<date-time> | null

updated_at__gte

string<date-time> | null

updated_at__lt

string<date-time> | null

sandbox_id__eq

string | null

page_id

string | null

limit

integer

default:100

Required range: x <= 100

include_sub_conversations

boolean

default:false

Response

Successful Response

items

AppConversation · object[]

required

Show child attributes

next_page_id

string | null

⌘I

OpenHands Cloud

Settings

Integrations

Cloud API

Organizations

Search App Conversations

Authorizations

Query Parameters

Response