Generate an image

Generates images from text prompts using the specified model.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

model*string

Model identifier in format provider/model

prompt*string

Text prompt to generate image

n?integer

Number of images to generate

size?string

Size of the generated image

quality?string

Quality of the generated image

style?string

Style of the generated image

response_format?string

Format of the response.

background?string

Background type for the image

moderation?string

Content moderation level

partial_images?integer

Number of partial images to generate

output_compression?integer

Compression level (0-100%)

output_format?string

Output image format

user?string

User identifier for tracking

seed?integer

Seed for reproducible image generation

negative_prompt?string

Negative prompt to guide what to avoid in generation

num_inference_steps?integer

Number of inference steps for generation

stream?boolean

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.

fallbacks?array<>

Fallback models to try if primary model fails

Response Body

`application/json`

curl -X POST "https://example.com/v1/images/generations" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "prompt": "string"  }'

{  "id": "string",  "created": 0,  "model": "string",  "data": [    {      "url": "http://example.com",      "b64_json": "string",      "revised_prompt": "string",      "index": 0    }  ],  "background": "string",  "output_format": "png",  "quality": "string",  "size": "256x256",  "usage": {    "input_tokens": 0,    "input_tokens_details": {      "image_tokens": 0,      "text_tokens": 0    },    "total_tokens": 0,    "output_tokens": 0,    "output_tokens_details": {      "image_tokens": 0,      "text_tokens": 0    }  },  "extra_fields": {    "request_type": "string",    "provider": "openai",    "model_requested": "string",    "model_deployment": "string",    "latency": 0,    "chunk_index": 0,    "raw_request": {},    "raw_response": {},    "cache_debug": {      "cache_hit": true,      "cache_id": "string",      "hit_type": "string",      "requested_provider": "string",      "requested_model": "string",      "provider_used": "string",      "model_used": "string",      "input_tokens": 0,      "threshold": 0,      "similarity": 0    }  }}

{  "event_id": "string",  "type": "string",  "is_bifrost_error": true,  "status_code": 0,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "event_id": "string"  },  "extra_fields": {    "provider": "openai",    "model_requested": "string",    "request_type": "string"  }}

{  "event_id": "string",  "type": "string",  "is_bifrost_error": true,  "status_code": 0,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "event_id": "string"  },  "extra_fields": {    "provider": "openai",    "model_requested": "string",    "request_type": "string"  }}

Authorization

Request Body

Response Body

200application/json

400application/json

500application/json

`application/json`

`application/json`