AI SDK - Black Forest Labs Provider

The Black Forest Labs provider for the AI SDK adds image model support for the Black Forest Labs API.

Setup

The Black Forest Labs provider is available in the @ai-sdk/black-forest-labs module. You can install it with

pnpm add @ai-sdk/black-forest-labs

Provider Instance

You can import the default provider instance blackForestLabs from @ai-sdk/black-forest-labs:

import { blackForestLabs } from '@ai-sdk/black-forest-labs';

Image Generation Example

import fs from 'node:fs';
import { blackForestLabs } from '@ai-sdk/black-forest-labs';
import { generateImage } from 'ai';

const { image } = await generateImage({
  model: blackForestLabs.image('flux-pro-1.1'),
  prompt: 'A cat wearing a intricate robe',
});

const filename = `image-${Date.now()}.png`;
fs.writeFileSync(filename, image.uint8Array);
console.log(`Image saved to ${filename}`);

Additional Options

If you want to pass additional inputs to the model besides the prompt, use the providerOptions.blackForestLabs property:

import {
  blackForestLabs,
  type BlackForestLabsImageProviderOptions,
} from '@ai-sdk/black-forest-labs';
import { generateImage } from 'ai';

const { image } = await generateImage({
  model: blackForestLabs.image('flux-pro-1.1'),
  prompt: 'A cat wearing an intricate robe',
  aspectRatio: '16:9',
  providerOptions: {
    blackForestLabs: {
      outputFormat: 'png',
    } satisfies BlackForestLabsImageProviderOptions,
  },
});

Configuring Base URL

By default, the provider uses https://api.bfl.ai/v1. You can override this to use regional or legacy endpoints:

import { createBlackForestLabs } from '@ai-sdk/black-forest-labs';

const blackForestLabs = createBlackForestLabs({
  baseURL: 'https://api.eu.bfl.ai/v1',
  apiKey: process.env.BFL_API_KEY,
});

Configuring Polling

You can customize how often the client polls for image completion and how long it waits before timing out:

import { createBlackForestLabs } from '@ai-sdk/black-forest-labs';

const blackForestLabs = createBlackForestLabs({
  apiKey: process.env.BFL_API_KEY,
  // Poll every 500ms, timeout after 5 minutes
  pollIntervalMillis: 500,
  pollTimeoutMillis: 5 * 60_000,
});

You can also override these polling settings per request via providerOptions.blackForestLabs:

import { blackForestLabs } from '@ai-sdk/black-forest-labs';
import { generateImage } from 'ai';

const { image } = await generateImage({
  model: blackForestLabs.image('flux-pro-1.1'),
  prompt: 'A cat wearing an intricate robe',
  providerOptions: {
    blackForestLabs: {
      pollIntervalMillis: 250,
      pollTimeoutMillis: 30_000,
    },
  },
});

Documentation

See the Black Forest Labs provider for more information.