Restack System API

The System API from Restack — 1 operation(s) for system.

OpenAPI Specification

restack-system-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Restack Agents System API
  description: The Restack API provides REST endpoints for scheduling, triggering, and managing AI agents and workflows. Restack automatically generates REST API endpoints for each agent and workflow registered in the platform, allowing programmatic invocation from any client application. Authentication is supported via Bearer tokens for secure access control.
  version: 1.0.0
  contact:
    name: Restack
    url: https://www.restack.io/
  license:
    name: Proprietary
    url: https://www.restack.io/terms
servers:
- url: http://localhost:6233
  description: Restack Local Server
- url: https://api.restack.io
  description: Restack Cloud API
security:
- bearerAuth: []
tags:
- name: System
paths:
  /health:
    get:
      operationId: healthCheck
      summary: Health Check
      description: Returns the health status of the Restack server.
      tags:
      - System
      security: []
      responses:
        '200':
          description: Server is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token for API authentication. Set via RESTACK_API_BEARER_TOKEN environment variable.