HirallHirall

Documentation

Everything you need to build with Hirall

Quick Start

Get up and running in minutes

1. Create an Account

Sign up for a free account to get started

# Visit the signup page
https://hirall.com/auth/signup

2. Get Your API Key

Create an API key from your dashboard

# Dashboard > API Keys > Create API Key

3. Make Your First Request

curl -X POST https://api.hirall.com/v1/collections \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "users"}'

Database

PostgreSQL with auto-generated APIs

  • • Collections & Documents
  • • Query & Filter
  • • Relationships
  • • Bulk Operations

Authentication

Secure user management

  • • Email/Password
  • • OAuth Providers
  • • Magic Links
  • • JWT Tokens

Storage

File uploads and management

  • • File Upload
  • • Buckets
  • • Image Transformations
  • • Signed URLs

Edge Functions

Serverless compute at the edge

  • • HTTP Triggers
  • • Database Triggers
  • • Scheduled Functions
  • • Environment Variables

API Endpoints

Base URL: https://api.hirall.com

Collections

GET /v1/collections
POST /v1/collections
DELETE /v1/collections/:name

Documents

GET /v1/collections/:name/documents
POST /v1/collections/:name/documents
PUT /v1/collections/:name/documents/:id
DELETE /v1/collections/:name/documents/:id

Storage

POST /v1/storage/:bucket/upload
GET /v1/storage/:bucket/files
DELETE /v1/storage/:bucket/:path

Ready to start building?