HELLCAT
← Back to Documentation

API Reference

Complete API documentation for Hellcat platform integration

Base URL

https://hellcat.pyrosec.gg

Authentication

Most endpoints require authentication using an API key or Bearer token:

Authorization: Bearer hc_your_api_key

Endpoints

GET/health

Health check endpoint

{ "status": "healthy", "timestamp": "..." }
GET/ready

Readiness probe

{ "status": "ready" }
POST/api/trpc/workflows.create
Auth Required

Create a new workflow

GET/api/trpc/workflows.list
Auth Required

List user workflows

POST/api/trpc/jobs.create
Auth Required

Create and execute a job

GET/api/trpc/jobs.get
Auth Required

Get job status and results

GET/api/trpc/billing.getBalance
Auth Required

Get credit balance

POST/admin/auth/login

Admin authentication

GET/admin/metrics/platform
Auth Required

Platform metrics (admin only)

tRPC Protocol

Hellcat uses tRPC for type-safe API communication. All tRPC endpoints are prefixed with:

/api/trpc/[router].[procedure]

Available Routers

  • workflows - Workflow management (create, list, update, delete)
  • jobs - Job execution (create, get, list, cancel, streamLogs)
  • billing - Credit management (getBalance, getTransactions, applyPromo)
  • streaming - Real-time workflow updates (WebSocket)
  • internal - Internal controller endpoints (restricted)

Example Usage

// Using fetch
const response = await fetch('/api/trpc/workflows.list', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer hc_your_api_key',
    'Content-Type': 'application/json'
  }
})

const data = await response.json()
console.log(data.result.data.workflows)

📚 Full API Documentation

For detailed schemas, request/response examples, and error codes, see the individual router documentation.