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

Restack Agents API

The Agents API from Restack — 2 operation(s) for agents.

Restack Agents API is one of 3 APIs that Restack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 2 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: http://localhost:6233, https://api.restack.io.

2 operations 2 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.restack.io
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Restack Agents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token for API authentication. Set via RESTACKAPIBEARERTOKEN environment variable.

Paths & Operations 2

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

Agents 2
POST
/api/agents/{agentName}
Schedule Agent
scheduleAgent 1 param body → 200401404500
GET
/api/agents/{agentName}/{runId}
Get Agent Run
getAgentRun 2 params → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are AgentRunStatus (7 properties), AgentRunResponse (2 properties), AgentRunRequest (1 property). Each schema is shown below with its type and property counts.

AgentRunResponse
object
2 properties
AgentRunRequest
object
1 property
AgentRunStatus
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

restack-agents-api-openapi.yml Raw ↑

Other APIs Restack publishes across the network.

Restack System API
Restack Workflows API