NVIDIA NIM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NVIDIA NIM Image Generation Images API

2 actions 2 updates phrasing extends openapi/nvidia-nim-images-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for NVIDIA NIM's API. It is a proposal applied on top of the contract, not a document NVIDIA NIM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/genai/{publisher}/{model}'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NVIDIA NIM Image Generation Images API
  version: 1.0.0
extends: openapi/nvidia-nim-images-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/genai/{publisher}/{model}'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate or edit an image from a prompt
      effect: write
      questions:
      - Can I create an image from a text prompt with FLUX.1, SDXL or Edify image models?
      - Is it possible to edit or inpaint an existing image by sending a source image and a mask?
      - Which settings, like width, height, steps and seed, can I control when generating an image?
      instructions:
      - text: Generate an image of {prompt} with the {publisher} model {model}.
        slots:
          prompt: requestBody.prompt
          publisher: path.publisher
          model: path.model
      - text: Create a {width}x{height} image of {prompt} using {publisher}/{model}, avoiding {negative_prompt}.
        slots:
          width: requestBody.width
          height: requestBody.height
          prompt: requestBody.prompt
          publisher: path.publisher
          model: path.model
          negative_prompt: requestBody.negative_prompt
      - text: Inpaint the image {image} inside mask {mask} to show {prompt} using {publisher}/{model}.
        slots:
          image: requestBody.image
          mask: requestBody.mask
          prompt: requestBody.prompt
          publisher: path.publisher
          model: path.model
      method: generated
      generated: '2026-10-01'