Skip to main content

​
Overview

The Hitler API is a RESTful API that powers all Hitler functionality. Whether you’re building a custom integration, bot adapter, or admin tool, this API provides the foundation.

​
Base URL

https://api.hitler.app/api

​
Authentication

Most endpoints require authentication via JWT bearer token. 
curl -X GET "https://api.hitler.app/api/auth/me" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
See Authentication for details on obtaining tokens.

​
Request Format

​
Headers

HeaderRequiredDescription
AuthorizationYes*Bearer token for authenticated endpoints
Content-TypeYesapplication/json for POST/PATCH requests
*Not required for public endpoints like login/register

​
Request Body

POST and PATCH requests expect JSON: 
{
  "email": "user@example.com",
  "password": "securepassword"
}

​
Response Format

​
Success Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "user@example.com",
  "name": "John Doe",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

​
Error Response

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}

​
Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid input
401Unauthorized - Missing or invalid token
403Forbidden - Insufficient permissions
404Not Found
409Conflict - Resource already exists
500Internal Server Error

​
Rate Limiting

Endpoint TypeLimit
Standard endpoints100 requests/minute
Auth endpoints20 requests/minute
Webhook endpoints1000 requests/minute
Rate limit headers: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642089600

​
Pagination

List endpoints support pagination: 
GET /api/tasks?limit=20&offset=0
Response includes pagination info: 
{
  "data": [...],
  "total": 150,
  "limit": 20,
  "offset": 0
}

​
Filtering

Many endpoints support query filters: 
GET /api/tasks?status=open
GET /api/moods?days=30
GET /api/flags?status=active

​
SDKs & Libraries

TypeScript SDK

Official SDK for Node.js and browser
npm install @hitler/sdk

OpenAPI Spec

Download the OpenAPI 3.0 specificationDownload JSON

​
Interactive Docs

For interactive API exploration, visit our Swagger UI:

​
API Modules

Auth

Login, register, token management

Organizations

Organization management

Users

User CRUD operations

Tasks

Task and draft management

Chat

Conversational AI interface

Moods

Mood tracking

Flags

Wellbeing flags