ICS Generator API

Lightweight API to create downloadable .ics calendar files from JSON. Ideal for appointment systems, booking confirmations and notifications.

What is this API?

This API accepts an event description in JSON and returns a standards-compliant iCalendar (.ics) file suitable for Google Calendar, Outlook, Apple Calendar and most calendaring apps. It is designed for server-to-server integration, lightweight embedding in emails and generating secure, single-use calendar links.

  • Generates ICS files (VEVENT) with timezone support
  • Supports alarms (VALARM), organizer and attendees
  • Outputs calendar as text/calendar for inline download
  • Usage tracking and per-user API keys

Quick Start

  1. Register with POST /api/auth/register using your email.
  2. Verify token via email: GET /api/auth/verify?email=...&token=... — you will receive an x-api-key.
  3. Generate ICS: POST /api/ics/create with header x-api-key: <your-key> and JSON body.

API Documentation

    See all endpoints from Swagger /docs

Authentication

Private API keys are issued after email verification. Send the key with the header x-api-key. Example:

x-api-key: your_api_key_here

API keys are checked for validity and usage is deducted per ICS generation.

Rate limits & quotas

Default rate limits apply (per IP / per key). Additionally each account can have a monthly credit quota which is deducted when an ICS file is created. If you need higher limits, contact support for a plan upgrade.

Security notes

  • All endpoints must be accessed over HTTPS.
  • API keys are stored hashed in the database (cannot be recovered).
  • Request bodies are validated—malformed events are rejected.
  • Log files are rotated and stored outside the application container.