Skip to main content
GET
List Agent Branches

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

The id of an agent. This is returned on agent creation.

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Query Parameters

include_archived
boolean
default:false

Whether archived branches should be included

limit
integer
default:100

How many results at most should be returned

Required range: x <= 100
include_commit_status
boolean
default:false

Whether to compute how far each branch has diverged from main (commits_ahead/commits_behind). This walks the version DAG of every branch, so it is slow on agents with long histories and is off by default, leaving those fields null.

Response

Successful Response

results
AgentBranchSummary · object[]
required
meta
ListResponseMeta · object