# @blockadelabs/sdk

> BlockadeLabs SDK

Latest version **1.1.7** (published 2023-08-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @blockadelabs/sdk
pnpm add @blockadelabs/sdk
yarn add @blockadelabs/sdk
bun add @blockadelabs/sdk
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2023-08-16 |
| First published | 2023-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 64.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | blockadelabs |
| Keywords | blockadelabs, artificial intelligence, stable diffusion, ai, sdk |

## Links

- npm: https://www.npmjs.com/package/@blockadelabs/sdk
- Repository: https://github.com/Blockade-Games/BlockadeLabs-SDK-Node
- Homepage: https://github.com/Blockade-Games/BlockadeLabs-SDK-Node/blob/main/README.md
- Issues: https://github.com/Blockade-Games/BlockadeLabs-SDK-Node/issues
- npm.io page: https://npm.io/package/@blockadelabs/sdk

## Dependencies (3)

- [zod](https://npm.io/package/zod.md) ^3.21.4
- [axios](https://npm.io/package/axios.md) ^1.3.4
- [form-data](https://npm.io/package/form-data.md) ^4.0.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.1.7 (latest) — 2023-08-16
- 1.1.6 — 2023-08-15
- 1.1.5 — 2023-06-30
- 1.1.4 — 2023-06-30
- 1.1.3 — 2023-06-01
- 1.1.2 — 2023-05-09
- 1.1.1 — 2023-04-19
- 1.1.0 — 2023-04-10
- 1.0.9 — 2023-04-05
- 1.0.8 — 2023-04-04
- 1.0.7 — 2023-04-04
- 1.0.6 — 2023-03-31
- 1.0.5 — 2023-03-30
- 1.0.4 — 2023-03-30
- 1.0.3 — 2023-03-30
- … 3 more at https://npm.io/package/@blockadelabs/sdk/versions

## README

# BlockadeLabs SDK

BlockadeLabs SDK for TypeScript/JavaScript

## Envs Supported

- Node.js
- Modern browsers

## How to Install

```
$ yarn add @blockadelabs/sdk

# or

$ npm i @blockadelabs/sdk
```

## Basic Usage

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY, // REQUIRED
});
```

## Methods Doc

#### getSkyboxStyles

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const styles = await sdk.getSkyboxStyles();
```

#### generateSkybox

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const generation = await sdk.generateSkybox({
  prompt: 'PROMPT_GOES_HERE', // Required
  skybox_style_id: 2, // Required
  webhook_url: 'YOUR_WEBHOOK_URL', // Optional
});
```

#### Remix Skybox

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const generation = await sdk.generateSkybox({
  prompt: 'PROMPT_GOES_HERE', // Required
  skybox_style_id: 2, // Required
  remix_id: 1, // OR remix_obfuscated_id
  webhook_url: 'YOUR_WEBHOOK_URL', // Optional
});
```

#### getImagineById

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const imagine = await sdk.generateImagine({
  generator: 'stable',
  generator_data: {
    prompt: 'PROMPT_GOES_HERE',
  },
});

const imagineResult = await sdk.getImagineById({
  id: imagine.id, // REQUIRED
});
```

#### getImagineByObfuscatedId

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const imagine = await sdk.generateImagine({
  generator: 'stable',
  generator_data: {
    prompt: 'PROMPT_GOES_HERE',
  },
});

const imagineResult = await sdk.getImagineByObfuscatedId({
  obfuscated_id: imagine.obfuscated_id, // REQUIRED
});
```

#### getImagineHistory

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const imagineHistory = await sdk.getImagineHistory();

const imagineHistoryWithFilters = await sdk.getImagineHistory({
  status: 'STATUS', // OPTIONAL
  limit: 10, // OPTIONAL
  offset: 0, // OPTIONAL
  order: 'ASC', // OPTIONAL
  imagine_id: 1, // OPTIONAL
  query: 'PROMPT', // OPTIONAL
  generator: 'GENERATOR', // OPTIONAL
});
```

#### cancelImagine

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

const generateImagine = await sdk.generateImagine({
  generator: 'stable',
  generator_data: { prompt: 'PROMPT_GOES_HERE' },
});

await sdk.cancelImagine({
  id: generateImagine.id, // REQUIRED
});
```

#### cancelAllPendingImagines

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

await sdk.cancelAllPendingImagines();
```

#### deleteImagine

```ts
import { BlockadeLabsSdk } from '@blockadelabs/sdk';

const sdk = new BlockadeLabsSdk({
  api_key: YOUR_API_KEY,
});

await sdk.deleteImagine({
  id: IMAGINE_ID_GOES_HERE, // REQUIRED
});
```

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