Access Profiles19

Anthropic Integration14

Async Jobs22

Audio2

Audit Logs5

Batch5

Bedrock Integration14

Cache2

Chat Completions1

Circuit Breaker5

Cohere Integration4

Compaction1

Configuration6

Containers9

Count Tokens1

Cursor Integration20

Embeddings1

Files5

GenAI Integration21

Governance48

Health1

Images3

Infrastructure4

LangChain Integration18

LiteLLM Integration17

Logging31

MCP13

MCP Tool Groups5

Models1

OAuth5

OCR1

OpenAI Integration51

Plugins6

Prompt Repository21

Providers15

PydanticAI Integration3

Images

Generate an image

Generates images from text prompts using the specified model.

post/v1/images/generations

Request

Base URL
http://localhost:8080
Auth
- HTTP bearer
- or HTTP basic
- or API key in header x-bf-vk
- or API key in header x-api-key
TypeScript
https://skmtc.dev/getbifrost/apis/bifrost-api/docs/v1/images/generations/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

modelstring required

Model identifier in format provider/model

promptstring required

Text prompt to generate image

ninteger

Number of images to generate

size'256x256' | '512x512' | '1024x1024' | '1792x1024' | '1024x1792' | '1536x1024' | '1024x1536' | 'auto'

Size of the generated image

Quality of the generated image

style'natural' | 'vivid'

Style of the generated image

response_format'url' | 'b64_json'

Format of the response.

background'transparent' | 'opaque' | 'auto'

Background type for the image

moderation'low' | 'auto'

Content moderation level

partial_imagesinteger

Number of partial images to generate

output_compressioninteger

Compression level (0-100%)

output_format'png' | 'webp' | 'jpeg'

Output image format

userstring

User identifier for tracking

seedinteger

Seed for reproducible image generation

negative_promptstring

Negative prompt to guide what to avoid in generation

num_inference_stepsinteger

Number of inference steps for generation

streamboolean

Whether to stream the response. When true, images are sent as SSE. When streaming, providers may return base64 chunks (b64_json) and/or URLs (url) depending on provider and configuration.

Response

Successful response. Returns JSON for non-streaming requests, or Server-Sent Events (SSE) stream when stream=true. When streaming, events are sent with the following event types:

image_generation.partial_image: Intermediate image chunks with base64-encoded image data
image_generation.completed: Final event for each image with usage information
error: Error events with error details

idstring

Unique identifier for the generation request

createdinteger

Unix timestamp when the image was created

modelstring

Model used for generation

backgroundstring