Ideogram

opencollection: 1.0.0
info:
  name: API Reference
  version: 1.0.0
items:
- info:
    name: subpackage_generate
    type: folder
  items:
  - info:
      name: Generate with Ideogram 3.0
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/generate
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: prompt
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: resolution
          type: text
          value: ''
        - name: aspect_ratio
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: negative_prompt
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: color_palette
          type: text
          value: ''
        - name: style_codes
          type: text
          value: ''
        - name: style_type
          type: text
          value: ''
        - name: style_preset
          type: text
          value: ''
        - name: custom_model_uri
          type: text
          value: ''
        - name: style_reference_images
          type: text
          value: ''
        - name: character_reference_images
          type: text
          value: ''
        - name: character_reference_images_mask
          type: text
          value: ''
    docs: 'Generates images synchronously based on a given prompt and optional parameters using the Ideogram 3.0 model.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Generate with Ideogram 3.0 (Transparent Background)
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/generate-transparent
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: prompt
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: upscale_factor
          type: text
          value: ''
        - name: aspect_ratio
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: negative_prompt
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
    docs: 'Generates images with transparent background synchronously based on a given prompt and optional parameters using

      the Ideogram 3.0 model. Images will be generated using maximum supported resolution at the specified aspect ratio

      to allow best results with upscaler. The selected resolution is written to the response, not the upscaled final

      resolution.


      `rendering_speed=FLASH` is not supported for transparent-background generation; the request will return a 400.

      Use `TURBO`, `DEFAULT`, or `QUALITY` '
  - info:
      name: Inpaint with Ideogram 3.0
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/inpaint
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
        - name: mask
          type: text
          value: ''
        - name: prompt
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: style_type
          type: text
          value: ''
        - name: style_preset
          type: text
          value: ''
        - name: color_palette
          type: text
          value: ''
        - name: style_codes
          type: text
          value: ''
        - name: style_reference_images
          type: text
          value: ''
        - name: character_reference_images
          type: text
          value: ''
        - name: character_reference_images_mask
          type: text
          value: ''
    docs: 'Inpaint a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of
      the image

      should be edited, while the prompt and chosen style can further guide the edit.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Remix with Ideogram 3.0
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/remix
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
        - name: prompt
          type: text
          value: ''
        - name: image_weight
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: resolution
          type: text
          value: ''
        - name: aspect_ratio
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: negative_prompt
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: color_palette
          type: text
          value: ''
        - name: style_codes
          type: text
          value: ''
        - name: style_type
          type: text
          value: ''
        - name: style_preset
          type: text
          value: ''
        - name: style_reference_images
          type: text
          value: ''
        - name: character_reference_images
          type: text
          value: ''
        - name: character_reference_images_mask
          type: text
          value: ''
    docs: 'Remix provided images synchronously based on a given prompt and optional parameters with the Ideogram 3.0 model.


      Input images are cropped to the chosen aspect ratio before being remixed.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Reframe with Ideogram 3.0
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/reframe
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
        - name: resolution
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: style_preset
          type: text
          value: ''
        - name: color_palette
          type: text
          value: ''
        - name: style_codes
          type: text
          value: ''
        - name: style_reference_images
          type: text
          value: ''
    docs: 'Reframe a square image to a chosen resolution with Ideogram 3.0. The supported image formats include JPEG, PNG,
      and WebP.


      Image links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Replace Background with Ideogram 3.0
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/replace-background
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
        - name: prompt
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: style_preset
          type: text
          value: ''
        - name: color_palette
          type: text
          value: ''
        - name: style_codes
          type: text
          value: ''
        - name: style_reference_images
          type: text
          value: ''
    docs: 'Replace the background of a given image synchronously using a prompt with Ideogram 3.0. The foreground subject

      will be identified and kept, while the background is replaced based on the prompt and chosen style.

      Supported image formats include JPEG, PNG, and WebP.

      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Remove Background
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/remove-background
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
    docs: 'Remove the background of a given image synchronously. The foreground subject

      is identified and returned on a transparent background. Supported image formats include JPEG,

      PNG, and WebP.

      Image links are available for a limited period of time; if you would like to keep the image,

      you must download it.

      '
  - info:
      name: Layerize Text
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/layerize-text
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
        - name: prompt
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
    docs: 'Analyzes an image to detect text regions, then returns each detected text block with its position, content, font
      information, and styling.


      The response includes a text-erased base image (background with all text removed) and a flat list of detected text blocks.


      Supported image formats include JPEG, PNG, and WebP (max size 10MB).


      Image links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Edit images with a prompt
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/edit
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: prompt
          type: text
          value: ''
        - name: images
          type: text
          value: ''
        - name: image_urls
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: resolution
          type: text
          value: ''
        - name: aspect_ratio
          type: text
          value: ''
        - name: transparent_background
          type: text
          value: ''
    docs: 'Edit one or more images using a text prompt. Provide images via file upload

      or Ideogram image URLs, and describe the desired edit in your prompt.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Upscale
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/upscale
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image_request
          type: text
          value: ''
        - name: image_file
          type: text
          value: ''
    docs: 'Upscale provided images synchronously with an optional prompt.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Generate (legacy)
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/generate
      headers:
      - name: Api-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Generates images synchronously based on a given prompt and optional parameters.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Edit with Ideogram 3.0 (legacy)
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/edit
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image
          type: text
          value: ''
        - name: mask
          type: text
          value: ''
        - name: prompt
          type: text
          value: ''
        - name: magic_prompt
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: rendering_speed
          type: text
          value: ''
        - name: style_type
          type: text
          value: ''
        - name: style_preset
          type: text
          value: ''
        - name: color_palette
          type: text
          value: ''
        - name: style_codes
          type: text
          value: ''
        - name: style_reference_images
          type: text
          value: ''
        - name: character_reference_images
          type: text
          value: ''
        - name: character_reference_images_mask
          type: text
          value: ''
    docs: 'Legacy: use [`POST /v1/ideogram-v3/inpaint`](/api-reference/api-reference/inpaint-v3) instead. This endpoint will
      be removed in a future release.


      Edit a given image synchronously using the provided mask with Ideogram 3.0. The mask indicates which part of the image

      should be edited, while the prompt and chosen style can further guide the edit.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you m'
  - info:
      name: Edit (legacy)
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/edit
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image_file
          type: text
          value: ''
        - name: mask
          type: text
          value: ''
        - name: prompt
          type: text
          value: ''
        - name: model
          type: text
          value: ''
        - name: magic_prompt_option
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: style_type
          type: text
          value: ''
    docs: 'Edit a given image synchronously using the provided mask. The mask indicates which part of the image

      should be edited, while the prompt and chosen style type can further guide the edit.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Remix (legacy)
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/remix
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image_request
          type: text
          value: ''
        - name: image_file
          type: text
          value: ''
    docs: 'Remix provided images synchronously based on a given prompt and optional parameters.


      Input images are cropped to the chosen aspect ratio before being remixed.


      Supported image formats include JPEG, PNG, and WebP.


      Images links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
  - info:
      name: Reframe (legacy)
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/reframe
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image_file
          type: text
          value: ''
        - name: resolution
          type: text
          value: ''
        - name: model
          type: text
          value: ''
        - name: num_images
          type: text
          value: ''
        - name: seed
          type: text
          value: ''
        - name: style_type
          type: text
          value: ''
    docs: 'Reframe a square image to a chosen resolution. The supported image formats include JPEG, PNG, and WebP.


      Image links are available for a limited period of time; if you would like to keep the image, you must download it.

      '
- info:
    name: subpackage_vision
    type: folder
  items:
  - info:
      name: Describe
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/describe
      headers:
      - name: Api-Key
        value: ''
      body:
        type: multipart-form
        data:
        - name: image_file
          type: text
          value: ''
        - name: describe_model_version
          type: text
          value: ''
    docs: 'Describe an image.


      Supported image formats include JPEG, PNG, and WebP.

      '
- info:
    name: subpackage_datasets
    type: folder
  items:
  - info:
      name: List datasets
      type: http
    http:
      method: GET
      url: https://api.ideogram.ai/datasets
      headers:
      - name: Api-Key
        value: ''
    docs: Lists all datasets for the authenticated user
  - info:
      name: Create a new dataset
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/datasets
      headers:
      - name: Api-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: Creates a new dataset
  - info:
      name: Get a dataset
      type: http
    http:
      method: GET
      url: https://api.ideogram.ai/datasets/:dataset_id
      headers:
      - name: Api-Key
        value: ''
      params:
      - name: dataset_id
        value: ''
        type: path
    docs: 'Returns a dataset by ID, including the total number of files and a list of each file''s name and size in bytes.

      '
  - info:
      name: Upload assets to a dataset
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/datasets/:dataset_id/upload_assets
      headers:
      - name: Api-Key
        value: ''
      params:
      - name: dataset_id
        value: ''
        type: path
      body:
        type: multipart-form
        data:
        - name: files
          type: text
          value: ''
    docs: 'Upload image assets to a dataset for model training. Accepts individual images (JPEG, PNG, WebP), optional .txt
      caption sidecar files, and/or ZIP archives containing images and captions. A dataset can contain up to 100 images.

      '
- info:
    name: subpackage_models
    type: folder
  items:
  - info:
      name: Train a custom Ideogram v3 model
      type: http
    http:
      method: POST
      url: https://api.ideogram.ai/v1/ideogram-v3/train-model
      headers:
      - name: Api-Key
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Start training a custom Ideogram v3 model from a dataset using default hyperparameters. The dataset must contain
      at least 15 images and a maximum of 100 images.

      '
  - info:
      name: List models
      type: http
    http:
      method: GET
      url: https://api.ideogram.ai/models
      headers:
      - name: Api-Key
        value: ''
      params:
      - name: scope
        value: ''
        type: query
        description: 'Controls which models are returned. Omit to return both owned and shared models combined. `owned` returns
          only models created by the authenticated user. `shared` returns only models shared with the user''s organization
          via the model registry.

          '
      - name: status
        value: ''
        type: query
        description: 'Filter by model status. Applied to owned models only; shared models in the model registry are already
          filtered to available versions. Example: `?status=TRAINING&status=COMPLETED`

          '
    docs: 'Lists custom models for the authenticated user. Use the `scope` parameter to control which models are returned.
      If omitted, returns both owned models and models shared with the user''s organization via the model registry. `owned`
      returns only models created by the user. `shared` returns only models shared via the model registry, excluding the user''s
      own models.

      '
  - info:
      name: Get model details
      type: http
    http:
      method: GET
      url: https://api.ideogram.ai/models/:model_id
      headers:
      - name: Api-Key
        value: ''
      params:
      - name: model_id
        value: ''
        type: path
    docs: 'Get detailed information about a specific custom model. The user must either own the model or the model must be
      shared with the user''s organization via the model registry. Returns 404 if the model is not found or not accessible.

      '
bundled: true