Terminal Use Tasks API
The Tasks API from Terminal Use — 14 operation(s) for tasks.
Terminal Use Tasks 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 Tasks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 19 operations across 14 paths, and defines 52 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.
19 operations
14 paths
52 schemas
2 DELETE7 GET8 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 19
Across 14 paths, the API surfaces 19 operations — 2 DELETE, 7 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Tasks 19
GET
/tasks
List Tasks
POST
/tasks
Create Task
POST
/tasks/migrate
Migrate Tasks Between Versions
DELETE
/tasks/name/{task_name}
Delete Task by Name
GET
/tasks/name/{task_name}
Get Task by Name
PUT
/tasks/name/{task_name}
Update Task by Name
GET
/tasks/name/{task_name}/stream
Stream Task Events by Name
DELETE
/tasks/{task_id}
Delete Task by ID
GET
/tasks/{task_id}
Get Task by ID
PUT
/tasks/{task_id}
Update Task by ID
POST
/tasks/{task_id}/cancel
Cancel Task
POST
/tasks/{task_id}/events
Send Event to Task
POST
/tasks/{task_id}/handler-end
Handler End
GET
/tasks/{task_id}/stream
Stream Task Events by ID
GET
/tasks/{task_id}/system-folder-types
List System Folder Types
GET
/tasks/{task_id}/system-folders/{folder_type}
Get System Folder
POST
/tasks/{task_id}/system-folders/{folder_type}/download-url
Get System Folder Download URL
POST
/tasks/{task_id}/system-folders/{folder_type}/sync-complete
Complete System Folder Sync
POST
/tasks/{task_id}/system-folders/{folder_type}/upload-url
Get System Folder Upload URL
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are VersionResponse (24 properties), TaskResponse (13 properties), Task (12 properties), Agent (11 properties). Each schema is shown below with its type and property counts.
ToolInputEndPart
object
Marks the end of tool input streaming.
3 properties
1 required
HandlerEndResponse
object
2 properties
2 required
StreamUsage
object
Token usage for streaming events.
3 properties
2 required
VersionResponse
object
Full version details.
24 properties
11 required
ACPType
string
Type of ACP server.
ValidationError
object
3 properties
3 required
TextPart
object
Text content part.
2 properties
1 required
DeleteResponse
object
2 properties
2 required
ToolResultPart
object
Tool execution result.
5 properties
3 required
PresignedUrlResponse
object
Response model for presigned URL operations.
5 properties
4 required
PresignedUrlRequest
object
Request model for presigned URL generation.
1 property
CreateTaskEventRequest
object
Request for POST /tasks/{taskid}/events Content accepts TextPart or DataPart only. Other message types (tool calls, reasoning, etc.) are agent-generated and se…
3 properties
FinishStepPart
object
Marks the end of a step (API call).
4 properties
2 required
SystemFolderSyncCompleteResponse
object
Response model for system folder sync-complete operation.
4 properties
4 required
SystemFolderResponse
object
Response model for a task's system folder record.
9 properties
3 required
TextStreamPartWrapper
Wrapper for TextStreamPart union for proper serialization.
TaskResponse
object
Task response model with optional related data based on relationships
13 properties
3 required
HandlerEndRequest
object
5 properties
SystemFolderType
string
Enumeration of system folder types that can be synced per-task.
FinishReason
string
Reason for stream completion.
CreateTaskRequest
object
Request for POST /tasks
7 properties
ReasoningEndPart
object
Marks the end of a reasoning block.
3 properties
1 required
SystemFolderSyncCompleteRequest
object
Request model for completing a system folder sync operation.
5 properties
3 required
Event
object
Event returned from the events API. Content is TextPart or DataPart (human-readable content only).
7 properties
4 required
FinishPart
object
Marks the end of the entire streaming session.
4 properties
2 required
ReasoningDeltaPart
object
Incremental reasoning content.
4 properties
2 required
AgentInputType
string
ToolCallPart
object
Complete tool call with parsed input.
5 properties
3 required
TextEndPart
object
Marks the end of a text block.
3 properties
1 required
TaskRelationships
string
Task relationships that can be loaded
SystemFolderTypeResponse
object
Response model for a system folder type from the registry.
3 properties
3 required
DataPart
object
Generic data part for unknown/passthrough content.
2 properties
1 required
TextStartPart
object
Marks the start of a text block.
3 properties
1 required
TextDeltaPart
object
Incremental text content.
4 properties
2 required
TaskStatus
string
Task
object
12 properties
3 required
MigrateTasksRequest
object
Request model for migrating tasks between versions.
4 properties
ToolInputDeltaPart
object
Incremental tool input JSON.
4 properties
2 required
SDKType
string
SDK type for agent runtime.
StartStepPart
object
Marks the start of a new step (API call).
4 properties
HandlerCompletePart
object
Marks completion of event/send handler lifecycle for a specific event.
6 properties
3 required
UpdateTaskRequest
object
1 property
ReasoningStartPart
object
Marks the start of a reasoning block.
3 properties
1 required
HTTPValidationError
object
1 property
VersionStatus
string
Status of a version in its lifecycle.
MigrateTasksResponse
object
Response model for task migration operation.
4 properties
3 required
StartPart
object
Marks the start of a streaming session.
1 property
ToolInputStartPart
object
Marks the start of tool input streaming.
4 properties
2 required
StreamMetadata
object
Extended metadata for finish events.
5 properties
AgentStatus
string
Agent status - runtime statuses (Ready/Failed/Unhealthy) now live on Deployment.
Agent
object
11 properties
6 required
StreamErrorPart
object
Error during streaming.
3 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Terminal Use 12
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
#Tasks