Get Conversation

GET /api/conversations/{conversation_id}

Get Conversation

cURL

curl --request GET \
  --url https://app.all-hands.dev/api/conversations/{conversation_id} \
  --header 'X-Session-API-Key: <api-key>'

import requests

url = "https://app.all-hands.dev/api/conversations/{conversation_id}"

headers = {"X-Session-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};

fetch('https://app.all-hands.dev/api/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://app.all-hands.dev/api/conversations/{conversation_id}",
  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-Session-API-Key: <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://app.all-hands.dev/api/conversations/{conversation_id}"

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

	req.Header.Add("X-Session-API-Key", "<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://app.all-hands.dev/api/conversations/{conversation_id}")
  .header("X-Session-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.all-hands.dev/api/conversations/{conversation_id}")

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

request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'

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

200

{
  "conversation_id": "<string>",
  "title": "<string>",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "status": "STOPPED",
  "selected_repository": "<string>",
  "selected_branch": "<string>",
  "num_connections": 0,
  "url": "<string>",
  "session_api_key": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "pr_number": [
    123
  ]
}

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

Authorizations

X-Session-API-Key · string · header · required

Path Parameters

conversation_id · string · required

Response

200

application/json

ConversationInfo · object | null

Successful Response

conversation_id · string · required

title · string · required

last_updated_at · string<date-time> | null

status · enum<string> · default: STOPPED

Available options: STARTING, RUNNING, STOPPED

runtime_status · enum<string> | null

Available options: STATUS$STOPPED, STATUS$BUILDING_RUNTIME, STATUS$STARTING_RUNTIME, STATUS$RUNTIME_STARTED, STATUS$SETTING_UP_WORKSPACE, STATUS$SETTING_UP_GIT_HOOKS, STATUS$READY, STATUS$ERROR, STATUS$ERROR_RUNTIME_DISCONNECTED, STATUS$ERROR_LLM_AUTHENTICATION, STATUS$ERROR_LLM_SERVICE_UNAVAILABLE, STATUS$ERROR_LLM_INTERNAL_SERVER_ERROR, STATUS$ERROR_LLM_OUT_OF_CREDITS, STATUS$ERROR_LLM_CONTENT_POLICY_VIOLATION, CHAT_INTERFACE$AGENT_RATE_LIMITED_STOPPED_MESSAGE, STATUS$GIT_PROVIDER_AUTHENTICATION_ERROR, STATUS$LLM_RETRY, STATUS$ERROR_MEMORY

selected_repository · string | null

selected_branch · string | null

git_provider · enum<string> | null

Available options: github, gitlab, bitbucket, enterprise_sso

trigger · enum<string> | null

Available options: resolver, gui, suggested_task, openhands_api, slack, microagent_management, jira, jira_dc, linear

num_connections · integer · default: 0

url · string | null

session_api_key · string | null

created_at · string<date-time>

pr_number · integer[]