Developer API

Read the overlay catalog, manage an inventory and create overlays from your own tools.

It's the same API the website and the desktop app use, so every rule (plans, limits, validation) applies to your tools exactly as it does to them.

The basics

Base URL: https://api.forgecast.in followed by /api/v1
Format: JSON in and out, UTF-8. Timestamps are ISO 8601 in UTC; IDs are UUIDs, and overlay slugs are lowercase words with dashes.
Auth: Authorization: Bearer fck_..., an API key.
Versioning: the version is in the path (/v1). Breaking changes will ship as /v2.

Create a key on your account page with the profile:read scope. How

Keep the address and the key in two variables, so the examples on these pages run as they are:

export FORGECAST_URL="https://api.forgecast.in"   # the API's address
export FORGECAST_KEY="fck_your_key_here"       # your API key

Ask who you are:

curl -s "$FORGECAST_URL/api/v1/me" \
  -H "Authorization: Bearer $FORGECAST_KEY"

Area	What it's for
Profile & account	Who the key belongs to: plan, entitlements and usage
Catalog & marketplace	Browse predefined overlays, widgets and themes
Inventory	List, read, add and remove the items an account owns
Your overlays	Create, update and fork overlays (Pro and Ultimate)
Sounds	Search the sound-effect catalog and fetch the audio
App updates	The desktop app's update check

Before you build: read Errors & limits (10 requests a minute per account), and the overlay document format if you'll write overlays. Building a native app that signs people in? Use desktop app sign-in instead of API keys.