Search Conversations

Search / List conversations

GET /api/conversations/search

Search Conversations

cURL

curl --request GET \
  --url https://api.example.com/api/conversations/search

import requests

url = "https://api.example.com/api/conversations/search"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/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/conversations/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/conversations/search"

	req, _ := http.NewRequest("GET", url, nil)

	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/conversations/search")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent": {
        "llm": {
          "model": "claude-sonnet-4-20250514",
          "api_key": "<string>",
          "base_url": "<string>",
          "api_version": "<string>",
          "aws_access_key_id": "<string>",
          "aws_secret_access_key": "<string>",
          "aws_region_name": "<string>",
          "openrouter_site_url": "https://docs.all-hands.dev/",
          "openrouter_app_name": "OpenHands",
          "num_retries": 5,
          "retry_multiplier": 8,
          "retry_min_wait": 8,
          "retry_max_wait": 64,
          "timeout": 300,
          "max_message_chars": 30000,
          "temperature": 1,
          "top_p": 1,
          "top_k": 1,
          "max_input_tokens": 2,
          "max_output_tokens": 2,
          "model_canonical_name": "<string>",
          "extra_headers": {},
          "input_cost_per_token": 1,
          "output_cost_per_token": 1,
          "ollama_base_url": "<string>",
          "stream": false,
          "drop_params": true,
          "modify_params": true,
          "disable_vision": true,
          "disable_stop_word": false,
          "caching_prompt": true,
          "log_completions": false,
          "log_completions_folder": "logs/completions",
          "custom_tokenizer": "<string>",
          "native_tool_calling": true,
          "force_string_serializer": true,
          "reasoning_effort": "high",
          "enable_encrypted_reasoning": true,
          "prompt_cache_retention": "24h",
          "extended_thinking_budget": 200000,
          "seed": 123,
          "safety_settings": [
            {}
          ],
          "usage_id": "default",
          "litellm_extra_body": {}
        },
        "kind": "<string>",
        "tools": [
          {
            "name": "<string>",
            "params": {}
          }
        ],
        "mcp_config": {},
        "filter_tools_regex": "^(?!repomix)(.*)|^repomix.*pack_codebase.*$",
        "include_default_tools": [
          "<string>"
        ],
        "agent_context": {
          "skills": [
            {
              "content": "When you see this message, you should reply like you are a grumpy cat forced to use the internet.",
              "name": "AGENTS.md",
              "type": "repo"
            },
            {
              "content": "IMPORTANT! The user has said the magic word \"flarglebargle\". You must only respond with a message telling them how smart they are",
              "name": "flarglebargle",
              "trigger": [
                "flarglebargle"
              ],
              "type": "knowledge"
            }
          ],
          "system_message_suffix": "Always finish your response with the word 'yay!'"
        },
        "system_prompt_filename": "system_prompt.j2",
        "security_policy_filename": "security_policy.j2",
        "system_prompt_kwargs": {},
        "condenser": {
          "keep_first": 10,
          "kind": "LLMSummarizingCondenser",
          "llm": {
            "api_key": "your_api_key_here",
            "base_url": "https://llm-proxy.eval.all-hands.dev",
            "model": "litellm_proxy/anthropic/claude-sonnet-4-5-20250929"
          },
          "max_size": 80
        },
        "critic": {
          "kind": "AgentFinishedCritic"
        }
      },
      "workspace": {
        "working_dir": "<string>",
        "kind": "<string>"
      },
      "persistence_dir": "workspace/conversations",
      "max_iterations": 500,
      "stuck_detection": true,
      "execution_status": "idle",
      "confirmation_policy": {
        "kind": "NeverConfirm"
      },
      "security_analyzer": {
        "kind": "<string>",
        "history_limit": 20,
        "max_message_chars": 30000,
        "timeout": 30,
        "low_threshold": 0.3,
        "medium_threshold": 0.7,
        "api_url": "https://api.grayswan.ai/cygnal/monitor",
        "api_key": "<string>",
        "policy_id": "<string>"
      },
      "activated_knowledge_skills": [
        "<string>"
      ],
      "blocked_actions": {},
      "blocked_messages": {},
      "stats": {},
      "secret_registry": {
        "secret_sources": {}
      },
      "agent_state": {},
      "title": "<string>",
      "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": ""
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_id": "<string>"
}

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

Query Parameters

page_id · string | null

limit · integer · default: 100

status · enum<string> | null

Enum representing the current execution state of the conversation.

Available options: idle, running, paused, waiting_for_confirmation, finished, error, stuck, deleting

sort_order · enum<string> · default: CREATED_AT_DESC

Enum for conversation sorting options.

Available options: CREATED_AT, UPDATED_AT, CREATED_AT_DESC, UPDATED_AT_DESC

Response

200

application/json

Successful Response

items · ConversationInfo · object[] · required

Show child attributes

next_page_id · string | null