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

The States API from Terminal Use — 2 operation(s) for states.

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

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

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

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 5

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

States 5
GET
/states
List States
states_list 6 params → 200422
POST
/states
Create Task State
states_create body → 200422
DELETE
/states/{state_id}
Delete Task State
states_delete 1 param → 200422
GET
/states/{state_id}
Get State by State ID
states_retrieve 1 param → 200422
PUT
/states/{state_id}
Update Task State
states_update 1 param body → 200422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are State (6 properties), CreateStateRequest (3 properties), ValidationError (3 properties), UpdateStateRequest (3 properties). Each schema is shown below with its type and property counts.

UpdateStateRequest
object
3 properties 3 required
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
State
object
Represents a state in the agent system. A state is associated uniquely with a task and an agent. This entity is used to store states in MongoDB, with each stat…
6 properties 5 required
CreateStateRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terminal-use-states-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 Agents 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