find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vee3-io:vee3-io-image-generation-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Vee3 Io Image Generation API
  version: 0.1.0
  description: 'Operations tagged image-generation across 2 of this provider''s published API definitions: vee3-io.json, vee3-io-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Image Generation
paths:
  /v1/image-generation/generate:
    post:
      tags:
      - Image Generation
      summary: Generate image
      description: Generate images from a text prompt and store them in account files.
      operationId: generate_image_v1_image_generation_generate_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateImageRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageGenerationResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /v1/image-generation/edit:
    post:
      tags:
      - Image Generation
      summary: Edit image
      description: Edit or compose images from stored files or public URLs.
      operationId: edit_image_v1_image_generation_edit_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditImageRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageGenerationResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    ImageGenerationResult:
      properties:
        generation_id:
          type: string
          title: Generation Id
        status:
          type: string
          title: Status
          default: completed
        prompt:
          type: string
          title: Prompt
        image_count:
          type: integer
          title: Image Count
        token_cost:
          type: integer
          title: Token Cost
        output_format:
          type: string
          title: Output Format
        size:
          anyOf:
          - type: string
          - type: 'null'
          title: Size
        created_at:
          type: string
          format: date-time
          title: Created At
        images:
          items:
            $ref: '#/components/schemas/StoredGeneratedImage'
          type: array
          title: Images
        install_command:
          type: string
          title: Install Command
        troubleshooting:
          type: string
          title: Troubleshooting
      type: object
      required:
      - generation_id
      - prompt
      - image_count
      - token_cost
      - output_format
      - created_at
      - images
      - install_command
      - troubleshooting
      title: ImageGenerationResult
    StoredGeneratedImage:
      properties:
        image_url:
          type: string
          title: Image Url
        file_name:
          type: string
          title: File Name
        file_size_bytes:
          type: integer
          title: File Size Bytes
        retained_until:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Retained Until
        download_code:
          type: string
          title: Download Code
        download_id:
          type: string
          title: Download Id
        expires_at:
          type: string
          format: date-time
          title: Expires At
        command:
          type: string
          title: Command
      type: object
      required:
      - image_url
      - file_name
      - file_size_bytes
      - download_code
      - download_id
      - expires_at
      - command
      title: StoredGeneratedImage
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    GenerateImageRequest:
      properties:
        prompt:
          type: string
          maxLength: 4000
          title: Prompt
          description: Text description of the image to generate or of the edit to apply.
        n:
          anyOf:
          - type: integer
            maximum: 10.0
            minimum: 1.0
          - type: 'null'
          title: N
          description: Number of images to generate (1 to 10). Each returned image costs 50 tokens.
          default: 1
        size:
          anyOf:
          - type: string
            maxLength: 32
          - type: 'null'
          title: Size
          description: Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio.
        output_format:
          type: string
          enum:
          - webp
          - png
          - jpeg
          title: Output Format
          description: Encoding of the returned image. webp is smaller; png is lossless.
          default: webp
        file_name:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: File Name
          description: Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name.
      type: object
      required:
      - prompt
      title: GenerateImageRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EditImageRequest:
      properties:
        prompt:
          type: string
          maxLength: 4000
          title: Prompt
          description: Text description of the image to generate or of the edit to apply.
        images:
          items:
            type: string
          type: array
          maxItems: 8
          minItems: 1
          title: Images
          description: Source images as stored file names from files.list_uploaded_files and/or public http or https image URLs. One image is an edit. Several images are composed into one scene. Upload files with files.upload_file first.
        n:
          anyOf:
          - type: integer
            maximum: 10.0
            minimum: 1.0
          - type: 'null'
          title: N
          description: Number of images to generate (1 to 10). Each returned image costs 50 tokens.
          default: 1
        size:
          anyOf:
          - type: string
            maxLength: 32
          - type: 'null'
          title: Size
          description: Optional output size as WIDTHxHEIGHT (for example 1024x1536) or auto. This sets aspect ratio, not exact pixel size. Omit for the default aspect ratio.
        output_format:
          type: string
          enum:
          - webp
          - png
          - jpeg
          title: Output Format
          description: Encoding of the returned image. webp is smaller; png is lossless.
          default: webp
        file_name:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: File Name
          description: Optional account-relative storage path for the image. When n is greater than 1, an index is inserted before the extension (for example art/fox.webp becomes art/fox-1.webp and art/fox-2.webp). If omitted, the file is stored under image-generation/ with a generated name.
      type: object
      required:
      - prompt
      - images
      title: EditImageRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- vee3-io.json
- vee3-io-openapi.json