lordraw/open-automator-fastapi repository overview

⁠Open-Automator API

RESTful API for executing and managing Open-Automator workflows programmatically.

⁠Overview

Open-Automator API provides a FastAPI-based REST interface for workflow automation. Execute workflows via HTTP requests, manage credentials securely, monitor execution status, and integrate automation into your applications and services.

⁠Key Features

• 🚀 REST API - Execute workflows via HTTP POST/GET requests
• 📊 Async Execution - Non-blocking workflow execution
• 🔐 Secure Authentication - API key and JWT token support
• 📝 OpenAPI/Swagger - Auto-generated interactive API documentation
• 🔄 Webhook Support - Trigger workflows from external events
• 📤 Result Retrieval - Query execution status and results
• 🎯 Job Queue - Manage concurrent workflow executions
• 🌐 Multi-Platform - Native support for AMD64 and ARM64 architectures

⁠Quick Start

⁠Basic Usage

docker run -d \
  -p 8000:8000 \
  --name open-automator-fastapi \
  lordraw/open-automator-fastapi:latest

Access API at http://localhost:8000 API Docs at http://localhost:8000/docs

⁠With Persistent Storage

docker run -d \
  -p 8000:8000 \
  -v $(pwd)/workflows:/app/workflows \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/logs:/app/logs \
  --name open-automator-fastapi \
  lordraw/open-automator-fastapi:latest

⁠With Authentication

docker run -d \
  -p 8000:8000 \
  -v $(pwd)/workflows:/app/workflows \
  -e API_KEY=your_secure_api_key_here \
  -e OA_WALLET_FILE=/app/data/wallet.enc \
  -e OA_WALLET_PASSWORD=wallet_password \
  --name open-automator-fastapi \
  lordraw/open-automator-fastapi:latest

⁠Custom Port

docker run -d \
  -p 3000:8000 \
  -v $(pwd)/workflows:/app/workflows \
  --name open-automator-fastapi \
  lordraw/open-automator-fastapi:latest

Access at http://localhost:3000

⁠Environment Variables

⁠Volume Mounts

⁠Docker Compose

⁠Basic Setup

version: '3.8'

services:
  api:
    image: lordraw/open-automator-fastapi:latest
    container_name: open-automator-fastapi
    ports:
      - "8000:8000"
    volumes:
      - ./workflows:/app/workflows
      - ./data:/app/data
      - ./logs:/app/logs
    environment:
      - API_KEY=your_secure_api_key
      - OA_LOG_LEVEL=INFO
    restart: unless-stopped

⁠Environment Variables

⁠Volume Mounts

⁠API Endpoints

⁠Core Endpoints

⁠Workflow Execution

⁠Workflow Management

⁠Webhooks

⁠Jobs & History

⁠Image Details

• Base Image: python:3.12-slim
• Size: ~500MB
• Platforms: linux/amd64, linux/arm64
• Exposed Port: 8000
• Working Directory: /app
• User: root (can be changed)

⁠Related Images

• open-automator-fastapi⁠ - shell
• open-automator-streamlit⁠ - UI
• open-automator-wallet⁠ - Wallet management

⁠Support

• Issues: GitHub Issues⁠
• Documentation: Full Docs⁠
• GitHub: https://github.com/lordraw77/open-automator⁠
• API Docs: http://localhost:8000/docs⁠

Built with ❤️ by the Open-Automator team