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

The Schedules API from Terminal Use — 5 operation(s) for schedules.

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

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

7 operations 5 paths 12 schemas 1 DELETE2 GET4 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 7

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

Schedules 7
GET
/agents/{agent_id}/schedules
List Agent Schedules
agents_schedules_list 2 params → 200422
POST
/agents/{agent_id}/schedules
Create Schedule
agents_schedules_create 1 param body → 200422
DELETE
/agents/{agent_id}/schedules/{schedule_name}
Delete Schedule
agents_schedules_delete 2 params → 200422
GET
/agents/{agent_id}/schedules/{schedule_name}
Get Schedule
agents_schedules_retrieve 2 params → 200422
POST
/agents/{agent_id}/schedules/{schedule_name}/pause
Pause Schedule
agents_schedules_pause 2 params body → 200422
POST
/agents/{agent_id}/schedules/{schedule_name}/trigger
Trigger Schedule
agents_schedules_trigger 2 params → 200422
POST
/agents/{agent_id}/schedules/{schedule_name}/unpause
Unpause Schedule
agents_schedules_unpause 2 params body → 200422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ScheduleResponse (11 properties), CreateScheduleRequest (10 properties), ScheduleListItem (6 properties), ScheduleSpecInfo (4 properties). Each schema is shown below with its type and property counts.

HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
PauseScheduleRequest
object
Request model for pausing a schedule
1 property
DeleteResponse
object
2 properties 2 required
ScheduleActionInfo
object
Information about the scheduled action
4 properties 3 required
UnpauseScheduleRequest
object
Request model for unpausing a schedule
1 property
ScheduleListResponse
object
Response model for listing schedules
2 properties 2 required
ScheduleSpecInfo
object
Information about the schedule specification
4 properties
ScheduleListItem
object
Abbreviated schedule info for list responses
6 properties 4 required
CreateScheduleRequest
object
Request model for creating a new schedule for an agent
10 properties 3 required
ScheduleState
string
Schedule state enum
ScheduleResponse
object
Response model for schedule operations
11 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

terminal-use-schedules-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