API Overview

The Waveify API is built on REST principles with a simple, predictable structure. All endpoints return SVG content that can be embedded directly in markdown.

RESTful Design

Clean, predictable API endpoints following REST principles

High Performance

Optimized SVG generation with caching for fast responses

CORS Enabled

Cross-origin requests supported for GitHub embedding

URL Parameters

All customization through simple query parameters

Base URL

All API requests should be made to this base URL

https://waveify.onrender.com/api

Example: https://waveify.onrender.com/api/wave?color=%23007CF0

Available Endpoints

Complete list of API endpoints and their purposes

Endpoint	Method	Description	Key Parameters
`/api/wave`	GET	Generate animated wave patterns	color, height, speed, amplitude, frequency
`/api/typing`	GET	Create typing animations	text, speed, color, fontSize, cursor
`/api/health`	GET	API health check	none