Agent-readable docs index: /docs/llms.txt. Full docs in one file: /docs/llms-full.txt. Download /docs/docs.zip to grep all markdown files locally.

Reference

Reference documentation is information-oriented. It provides rigorous, precise descriptions of Shaf machinery, endpoints, parameters, and return schemas.

Developer REST API v1

API Overview & Auth
Base conventions, bearer tokens, rate limits, and response envelope shapes.
Links API Endpoints
Create, list, update, and delete short links with smart routing attributes.
Custom Domains API
Automate domain registration, CNAME validation, and SSL cert issuance.
Organizations API
Programmatic workspace provisioning, team member roles, and quota inspections.
AI & OpenGraph Tools
Generate optimized short slugs and dynamic social preview metadata with edge AI.

Platform Specifications

Webhook Events Catalog
Real-time payload schemas, subscription filters, and HMAC-SHA256 signature verification.
Plans & Limits Matrix
Comprehensive tier comparison: Free, Pro, and Enterprise quotas and bandwidth.
Standard Error Codes
Exhaustive HTTP error codes, error string constants, and resolution advice.