Skip to main content
GET
Batch Get App Conversations

Authorizations

X-Access-Token
string
header
required

Query Parameters

ids
string[]
required

Response

(AppConversation · object | null)[]

Successful Response

created_by_user_id
string | null
required
sandbox_id
string
required
acp_server
string | null
required

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.

launched_agent_profile
LaunchedAgentProfile · object | null
required

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 }.

id
string
selected_repository
string | null
selected_branch
string | null
git_provider
enum<string> | null
Available options:
github,
gitlab,
bitbucket,
bitbucket_data_center,
forgejo,
azure_devops,
enterprise_sso
title
string | null
trigger
enum<string> | null
Available options:
resolver,
gui,
suggested_task,
openhands_api,
slack,
microagent_management,
jira,
jira_dc,
linear,
bitbucket,
automation
pr_number
integer[]
llm_model
string | null
agent_kind
string
default:openhands
metrics
MetricsSnapshot · object | null

A snapshot of metrics at a point in time.

Does not include lists of individual costs, latencies, or token usages.

parent_conversation_id
string | null
sub_conversation_ids
string[]
public
boolean | null
tags
Tags · object
created_at
string<date-time>
updated_at
string<date-time>
sandbox_status
enum<string>
default:MISSING

Current sandbox status. Will be MISSING if the sandbox does not exist.

Available options:
STARTING,
RUNNING,
PAUSED,
ERROR,
MISSING
execution_status
enum<string> | null

Current agent status. Will be None if the sandbox_status is not RUNNING

Available options:
idle,
running,
paused,
waiting_for_confirmation,
finished,
error,
stuck,
deleting
conversation_url
string | null

The URL where the conversation may be accessed

session_api_key
string | null

The Session Api Key for REST operations.