# @shuddho11288/sdxl-imagine

> A Node.js library for interacting with the Stable Diffusion XL API

Latest version **1.1.0** (published 2024-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @shuddho11288/sdxl-imagine
pnpm add @shuddho11288/sdxl-imagine
yarn add @shuddho11288/sdxl-imagine
bun add @shuddho11288/sdxl-imagine
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-04-11 |
| First published | 2024-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tasawar Ahmed Shuddho |
| Maintainers | shuddho11288 |
| Keywords | sdxl-imagine, api, image-generation |

## Links

- npm: https://www.npmjs.com/package/@shuddho11288/sdxl-imagine
- Repository: https://github.com/shuddho11288/sdxl-imagine
- Homepage: https://github.com/shuddho11288/sdxl-imagine#readme
- Issues: https://github.com/shuddho11288/sdxl-imagine/issues
- npm.io page: https://npm.io/package/@shuddho11288/sdxl-imagine

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.24.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2024-04-11
- 1.0.0 — 2024-04-11

## README

# Using the Imagine API

## Introduction
Imagine is an API that generates predictions based on given prompts. This document provides guidance on how to use the Imagine API.

## Installation
To use the Imagine API, you'll need Node.js installed on your system.

1. Install Node.js from [nodejs.org](https://nodejs.org/).
2. Create a new directory for your project and navigate into it using the terminal.
3. Initialize a new Node.js project using `npm init -y`.
4. Install Imagine API package using `npm install git+https://github.com/shuddho11288/imagine-api.git`.

## Usage
Follow these steps to use the Imagine API:

1. Import the Imagine API package into your project.
2. Initialize the `imagine` function by calling it with your desired prompt.
3. The function returns a promise with the predictions generated by Imagine.

Here's an example code snippet:

```javascript
const { imagine } = require('@shuddho11288/sdxl-imagine');

// Example usage
imagine('among us impostor but in good mood!').then(data=>{
    console.log(data)
})

---
_Source: https://npm.io/package/@shuddho11288/sdxl-imagine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._