A comprehensive list of changes published to the API reference

4th December, 2024

Features

Added support for ControlNet/Pose Lock on Flux Models and Styles.

APIs

  • Head over to List Controlnets API GET /pub/v1/controlnets?type=flux and you will see new controlnets for the Flux model.
Response
      "data": [
          {
              "base_model": "flux",
              "name": "Canny"
          },
          {
              "base_model": "flux",
              "name": "Depth"
          }
      ]
  • Use the control_net in the request body of POST /pub/v1/generations with flux models and styles to generate images with ControlNet/Pose Lock

When using control_net with Flux Model or Style, please note that the output image’s aspect ratio will automatically match the aspect ratio of the ControlNet reference image (specified by asset_id), regardless of any other aspect ratio settings.

resize_mode and control_mode are not supported for control_net when used with Flux Model or Style.

8th November, 2024

Features

Added support for Flux Generation.

APIs

  • flux model support in the request body of POST /pub/v1/generations.
    Example request
    [
  {
    "aspect_ratio": "4:5",
    "batch_size": 1,
    "model": "Flux",
    "prompt": {
      "negative": "",
      "positive": "a man looking into the camera."
    }
  }
]
  • flux style in the request body of POST /pub/v1/generations.
    Example request
    [
  {
    "aspect_ratio": "4:5",
    "batch_size": 1,
    "style_detail": {
      "name": "Black & White",
      "base_model": "flux"
    },
    "prompt": {
      "negative": "",
      "positive": "a man looking into the camera."
    }
  }
]
  • Added style_detail field along with style in response body of POST /pub/v1/generations.
    Example response
    {
  "data": {
      "credits_remaining": 100,
      "generation_id": "gen_001",
      "media": [
          {
              "dim": {
                  "height": 1280,
                  "width": 1024
              },
              "id": "img_01",
              "status": "initiated",
              "style": "Black & White",
              "style_detail": {
                  "base_model": "flux",
                  "name": "Black & White"
              },
              "type": "image"
          }
      ],
      "result": "initiated"
  },
  "err": {}
}
  • type support in the query param of GET /pub/v1/models, GET /pub/v1/styles, GET /pub/v1/controlnets and GET /pub/v1/loras.
    Example
    GET /pub/v1/styles?type=flux

4th September, 2024

Features

Added support for Narrator Generation.

APIs

  • Added narrator to the request body of POST /pub/v1/generations.

    Example request
    "narrator": {
  "image_asset_id": "ast_xxxxxxxx",
  "video_asset_id": "ast_xxxxxxxx",
  "audio_asset_id": "ast_xxxxxxxx",
  "script": "Thank you for trying Narrator",
  "voice": "Rachel"
}

  • Changes to the response in the following existing endpoints:

    1. Generate Media POST /pub/v1/generations
      • images renamed to media
      • image_size renamed to dim under data→media
      • type added under data→media
    1. List Generations GET /pub/v1/generations
      • images renamed to media under data in response.
      • size renamed to dim under data→media in response.
      • type added under data→media in response
      • image_id changed to media_id in Query Parameter

Was this page helpful?