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 Versions API

The Versions API from Terminal Use — 6 operation(s) for versions.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 6 operations across 6 paths, and defines 23 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.

6 operations 6 paths 23 schemas 5 GET1 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 6

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

Versions 6
POST
/versions/register
Register Container
versions_register body → 200422
GET
/versions/{version_id}
Get Version
retrieve 1 param → 200422
GET
/versions/{version_id}/deploy/events
Stream Deployment Progress
versions_deploy_stream 1 param → 200422
GET
/versions/{version_id}/metrics
Get Version Metrics
versions_metrics 1 param → 200422
GET
/versions/{version_id}/pod-logs
Get Version Pod Logs
versions_pod_logs 9 params → 200422
GET
/versions/{version_id}/pod-metrics
Get Version Pod Metrics
versions_pod_metrics 3 params → 200422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are VersionResponse (24 properties), VersionPodLogEntry (11 properties), VersionPodMetricsResponse (7 properties), DeployStreamFailedEvent (5 properties). Each schema is shown below with its type and property counts.

VersionResponse
object
Full version details.
24 properties 11 required
ValidationError
object
3 properties 3 required
ACPType
string
Type of ACP server.
VersionPodMetricsResponse
object
Pod-level CPU + memory metrics for a deployed version (last N minutes).
7 properties 2 required
DeployStreamRollingBackEvent
object
Deployment is being rolled back.
4 properties 2 required
DeployStreamErrorEvent
object
Sent when an error occurs in the deploy stream. After this event, the stream may close.
2 properties 1 required
DeployStreamHelmWaitingEvent
object
Waiting for Helm deployment to complete (pods becoming ready).
4 properties 2 required
DeployStreamReadyEvent
object
Deployment completed successfully.
4 properties 2 required
DeployStreamFailedEvent
object
Deployment failed.
5 properties 2 required
DeployStreamQueuedEvent
object
Deployment has been queued for processing.
4 properties 2 required
VersionMetricsResponse
object
Response model for version deployment metrics.
2 properties
RegisterContainerResponse
object
Response from container registration.
5 properties 5 required
DeployStreamHelmStartedEvent
object
Helm deployment has started.
4 properties 2 required
DeployStreamEvent
Union of all possible deploy stream SSE events. Use the 'type' field to discriminate between event types: - "connected": Stream connection established - "queue…
DeployStreamCompleteEvent
object
Stream is complete - deployment has reached a terminal state. Sent by the SSE endpoint when the version status is terminal (ACTIVE, FAILED, etc.).
2 properties 1 required
SDKType
string
SDK type for agent runtime.
VersionPodLogEntry
object
A single pod log entry returned for a deployment version.
11 properties 5 required
HTTPValidationError
object
1 property
DeployStreamConnectedEvent
object
Sent when SSE deploy stream connection is established. Indicates the client is now subscribed and will receive deployment progress events.
2 properties 1 required
RegisterContainerRequest
object
Request model for container registration. Called by agent container on startup to register its ACP URL. Includes a registration token for security (CVE-2026-00…
4 properties 3 required
VersionStatus
string
Status of a version in its lifecycle.
TimeSeriesPoint
object
A single time series data point.
2 properties 2 required
VersionPodLogsResponse
object
Paginated pod logs for a deployed version.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terminal-use-versions-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 Branches 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
#Versions
← Back to T APIs
API Details
ID
terminal-use:terminal-use-versions-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