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

Terminal Use Agents API

The Agents API from Terminal Use — 7 operation(s) for agents.

Terminal Use Agents 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 Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 7 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 7 paths 15 schemas 2 DELETE6 GET2 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 7 paths, the API surfaces 10 operations — 2 DELETE, 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Agents 10
GET
/agents
List Agents
agents_list 6 params → 200422
POST
/agents/deploy
Deploy Agent
deploy body → 201422
GET
/agents/forward/name/{namespace_slug}/{agent_name}/{path}
Forward GET request to agent by name
forward_get_request_to_agent_by_name 3 params → 200422
POST
/agents/forward/name/{namespace_slug}/{agent_name}/{path}
Forward POST request to agent by name
rpc_by_name 3 params → 200422
DELETE
/agents/name/{namespace_slug}/{agent_name}
Delete Agent by Name
agents_delete_by_name 2 params → 200422
GET
/agents/name/{namespace_slug}/{agent_name}
Get Agent by Name
agents_retrieve_by_name 2 params → 200422
DELETE
/agents/{agent_id}
Delete Agent by ID
agents_delete 1 param → 200422
GET
/agents/{agent_id}
Get Agent by ID
agents_retrieve 1 param → 200422
GET
/agents/{agent_id}/metrics
Get Agent Metrics
agents_retrieve_metrics 2 params → 200422
GET
/agents/{namespace_slug}/{agent_name}/versions
List Versions for Agent
agents_list_versions 5 params → 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), Agent (11 properties), DeployResponse (6 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
ACPType
string
Type of ACP server.
VersionResponse
object
Full version details.
24 properties 11 required
HTTPValidationError
object
1 property
DeleteResponse
object
2 properties 2 required
ValidationError
object
3 properties 3 required
VersionStatus
string
Status of a version in its lifecycle.
AgentMetricsResponse
object
Aggregated metrics for an agent.
4 properties 2 required
AgentInputType
string
SDKType
string
SDK type for agent runtime.
VersionListResponse
object
Response for listing versions of a branch.
3 properties 2 required
AgentListItem
object
Minimal agent shape for discovery/listing. The /agents list endpoint is authorized via discover and must not leak read-level fields (e.g. description, registra…
4 properties 3 required
AgentStatus
string
Agent status - runtime statuses (Ready/Failed/Unhealthy) now live on Deployment.
Agent
object
11 properties 6 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-agents-api-openapi.yml Raw ↑

Other APIs Terminal Use publishes across the network.

Terminal Use Agent APIKeys API
Terminal Use Agent Task Tracker API
Terminal Use API Keys API
Terminal Use Authentication API
Terminal Use Branch Events API
Terminal Use Branches API
Terminal Use Builds API
Terminal Use CLI Authentication API
Terminal Use Environments API
Terminal Use Events API
Terminal Use Filesystems API
Terminal Use Groups API