Skip to content
Last updated

Bria API v2 – Now Live in Production

A new version of our Image Editing API – v2 – is now available, offering enhanced stability, improved reliability, and a smoother experience for developers. We recommend using v2 for all new integrations. If you're currently using v1, there's a transition period in place to help you migrate at your own pace.

What’s New in v2

Bria API v2 builds on the solid foundation of v1, introducing enhancements that make integration even smoother and more scalable:

  • Async by Default – All endpoints now use asynchronous processing by default, enabling better scalability and performance for high-volume workflows.
  • Status Service – A new service designed to support async processing. It allows you to track the status of each request in real time and manage results more effectively.
  • Request ID for Every Call – Each request now includes a unique Request ID, making it easier to trace, debug issues, and collaborate with support when needed.
  • Unified Request & Response Format – Standardized structures across endpoints simplify integration and response handling.
  • Simplified Output Handling – Each request now returns a single result, making it easier to work with the output.
  • Consistent Error Handling – All endpoints now use a shared error structure with standardized codes and messages for better clarity.
  • Prompt-Level Moderation – Image Editing now supports prompt-level content moderation, helping automatically block unsafe or restricted terms.
  • Separate Moderation for Input and Output Images – Visual content moderation has been split to allow separate controls for input and output images, giving you more granular moderation flexibility across the flow.

Migration Timeline

The new version of our API – v2 – will run in parallel with the existing v1 endpoints for a limited transition period, giving you time to migrate smoothly.

  • Image Editing:
    Both versions are currently supported. Support for v1 endpoints will officially end on November 15, 2025.

  • Image Generation and Tailored Generation (Phase 2), and Product Shot Editing (Phase 3):
    Migration timelines will be shared separately as those capabilities become available in v2.

We recommend starting the migration process early to ensure a smooth transition.

Integration Notes

If you're currently using Bria API v1 for Image Editing, we encourage you to begin migrating to v2 to take advantage of the new improvements and ensure future compatibility.

Other integration methods — including iframe, MCP server, Photoshop and Figma plugins, and ComfyUI nodes — are not affected by this update.

Integration Guide

To help with a smooth migration, the table below matches each Image Editing v1 endpoint to its new v2 counterpart, including the updated API path and a link to the relevant documentation.

v1 Endpoint Pathv2 Endpoint Pathv2 Documentation
/v1/background/blur/v2/image/edit/blur_backgroundBlur Background
/v1/eraser/v2/image/edit/eraseEraser
/v1/gen_fill/v2/image/edit/gen_fillGenerative Fill
/v1/background/remove/v2/image/edit/remove_backgroundRemove Background
/v1/background/replace/v2/image/edit/replace_backgroundGenerate Background
/v1/enhance_image/v2/image/edit/enhanceEnhance Image
/v1/image/increase_resolution/v2/image/edit/increase_resolutionIncrease Resolution
/v1/crop/v2/image/edit/crop_foregroundCrop Out Foreground
/v1/image_expansion/v2/image/edit/expandExpand Image
/v1/erase_foreground/v2/image/edit/erase_foregroundErase Foreground

Parameter Name Changes from v1 to v2

General Changes (Across Multiple Endpoints)

Old Parameter (v1)New Parameter (v2)Notes
sync (default true)sync (default false)Default changed to asynchronous processing for improved scalability
num_resultsRemovedEach request now returns exactly one result
image_url + image_fileimageUnified into a single parameter; supports both Base64-encoded data and publicly accessible URLs
content_moderationprompt_content_moderation, visual_input_content_moderation, visual_output_content_moderationSplit into three independent controls for greater flexibility

Image Editing Endpoints

Old Parameter (v1)New Parameter (v2)Notes
mask_imagemaskStandardized naming
ref_image_url + ref_image_fileref_imagesSupports both Base64 and URLs
force_rmbgforce_background_detectionClearer naming
preserve_partial_alphapreserve_alphaUnified into one parameter for both full and partial alpha handling

🔍 To learn how to track request status in v2, visit the Status Service.

For any migration support, feel free to contact us at support@bria.ai.