API Reference

Complete reference for the Ssiat API.

Base URL

https://ssiat.dev/api/v1

Authentication

All requests require an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints Overview

Method	Endpoint	Description
POST	/og/generate	Generate an OG image
GET	/og/templates	List available templates
GET	/user/profile	Get user profile
GET	/stats/usage	Get usage statistics

Response Format

All responses follow this structure:

Success Response

{
  "success": true,
  "data": {
    // Response data
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

HTTP Status Codes

Status	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
404	Not Found - Resource doesn't exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Rate Limits

Plan	Limit
Free	10 requests/minute
Pro	60 requests/minute
Team	200 requests/minute

Rate limit headers are included in responses:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1704067200

Interactive API Docs

For interactive API testing, visit our Scalar API Reference.