API Reference

Interactive REST API documentation for the Lyra Express server

The Lyra Express API wraps all lyra-sdk functions behind REST endpoints. Start the server with:

cd packages/sdk-examples && npm run dev:express

All endpoints are available at http://localhost:3000/api/.

Try it out

Use the interactive playground on each endpoint page to send real requests to your local server.

Endpoints

Error Responses

All errors follow the same format:

{
  "error": {
    "code": 404,
    "message": "Video not found: INVALID_ID"
  }
}
HTTP StatusCause
400Validation error (Zod) or invalid URL
401Invalid YouTube API key
404Video/channel/playlist not found
429YouTube API quota exceeded
502YouTube API error
500Internal server error

On this page