> ## Documentation Index
> Fetch the complete documentation index at: https://lummi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# About

Lummi SDK is a type-safe REST API wrapper for Lummi AI, offering tools for searching, retrieving, and customizing images with features like filters, metadata, and advanced image effects.

### Tech

Lummi SDK now supports all features of the Lummi API for JavaScript runtimes such as Node, Bun, Deno and similar. If you're using a different programming language, refer to the [Lummi REST API Documentation](https://www.lummi.ai/docs/api).

<img className="block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/lummi/images/hero-light.svg" alt="Lummi AI Hero Light" onDragStart={(e) => e.preventDefault()} />

<img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/lummi/images/hero-dark.svg" alt="Lummi AI Hero Dark" onDragStart={(e) => e.preventDefault()} />

<Note>
  This package is not officially maintained by the Lummi AI team but is
  provided as a community-driven project. It serves as a better alternative to
  the REST API, offering a type-safe SDK with improved usability, scalability,
  and security. For official support, refer to the [Lummi API
  Documentation](https://www.lummi.ai/docs/api).
</Note>

## Why Choose Lummi SDK?

The SDK offers significant advantages over the direct use of the API if you are using JavaScript runtimes. Below are the key benefits:

<Accordion title="Type Safe">
  Enjoy IntelliSense and type checking in your code editor with Lummi SDK's
  type-safe wrapper around the Lummi API.
</Accordion>

<Accordion title="Ease of Use">
  A simple and intuitive interface makes interacting with the Lummi API
  straightforward.
</Accordion>

<Accordion title="Scalability">
  Built to handle large volumes of requests efficiently, ensuring robust
  performance for high-demand applications.
</Accordion>

<Accordion title="Security">
  Automatic handling of authentication and rate limiting, so you can focus on
  your application logic without extra overhead.
</Accordion>