Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Terminal Use

Terminal Use Branches API

The Branches API from Terminal Use — 10 operation(s) for branches.

Documentation Provider Profile APIs.io OpenAPI GitHub

Terminal Use Branches API is one of 28 APIs that Terminal Use publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Branches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.terminaluse.com.

10 operations 10 paths 15 schemas 5 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.terminaluse.com
Resource Areas
1

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Branches 10
POST
/agents/deploy
Deploy Agent
deploy body → 201422
GET
/agents/{namespace_slug}/{agent_name}/branch
Get Branch by Agent and Git Branch
agents_branches_retrieve 3 params → 200422
GET
/agents/{namespace_slug}/{agent_name}/branches
List Branches by Agent
agents_branches_list 3 params → 200422
POST
/agents/{namespace_slug}/{agent_name}/branches/{branch}/rollback
Rollback Branch by Git Branch Name
agents_branches_rollback 3 params body → 200422
POST
/agents/{namespace_slug}/{agent_name}/environments/{env_name}/rollback
Rollback Environment
agents_environments_rollback_create 3 params body → 200422
GET
/branches/{branch_id}
Get Branch
branches_retrieve 1 param → 200422
POST
/branches/{branch_id}/redeploy
Redeploy with Updated Secrets
branches_redeploy 1 param → 200422
POST
/branches/{branch_id}/rollback
Rollback Branch
branches_rollback 1 param body → 200422
GET
/branches/{branch_id}/versions
List Versions
branches_versions_list 2 params → 200422
GET
/versions/{version_id}
Get Version
retrieve 1 param → 200422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are VersionResponse (24 properties), DeployRequest (15 properties), BranchResponse (10 properties), RollbackResponse (7 properties). Each schema is shown below with its type and property counts.

DeployResponse
object
Immediate response from deploy request. CLI polls GET /branches/{branchid} or GET /versions/{versionid} for status updates.
6 properties 5 required
VersionListResponse
object
Response for listing versions of a branch.
3 properties 2 required
BranchResponse
object
Full branch details including current version.
10 properties 5 required
ACPType
string
Type of ACP server.
VersionResponse
object
Full version details.
24 properties 11 required
RollbackResponse
object
Response from a rollback operation.
7 properties 7 required
HTTPValidationError
object
1 property
VersionStatus
string
Status of a version in its lifecycle.
RollbackRequest
object
Request model for rolling back a branch.
1 property
ValidationError
object
3 properties 3 required
SDKType
string
SDK type for agent runtime.
VersionSummary
object
Abbreviated version info for embedding in branch responses.
6 properties 4 required
RedeployResponse
object
Response from a redeploy operation.
4 properties 4 required
BranchListResponse
object
Response for listing branches.
2 properties 2 required
DeployRequest
object
Request model for deploying an agent. Called by CLI after pushing the container image to the registry.
15 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terminal-use-branches-api-openapi.yml Raw ↑

Other APIs Terminal Use publishes across the network.

Terminal Use Agent APIKeys API
AE Profile APIs.io
Terminal Use Agent Task Tracker API
AE Profile APIs.io
Terminal Use Agents API
AE Profile APIs.io
Terminal Use API Keys API
AE Profile APIs.io
Terminal Use Authentication API
AE Profile APIs.io
Terminal Use Branch Events API
AE Profile APIs.io
Terminal Use Builds API
AE Profile APIs.io
Terminal Use CLI Authentication API
AE Profile APIs.io
Terminal Use Environments API
AE Profile APIs.io
Terminal Use Events API
AE Profile APIs.io
Terminal Use Filesystems API
AE Profile APIs.io
Terminal Use Groups API
AE Profile APIs.io
#Branches
← Back to T APIs
API Details
ID
terminal-use:terminal-use-branches-api
Base URL
https://api.terminaluse.com
Docs
https://docs.terminaluse.com
Provider
Terminal Use
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network