Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 8.35 KB

README.md

File metadata and controls

61 lines (42 loc) · 8.35 KB

Images

(images)

Overview

OpenAI's API images v1 endpoint

Available Operations

generate

This endpoint processes requests to generate images using AI models by forwarding them to the appropriate AI node. The request metadata and compute units have already been validated by middleware before reaching this handler.

Errors

  • Returns various status codes based on the underlying handle_image_generation_response:
    • INTERNAL_SERVER_ERROR - If there's an error communicating with the AI node

Example Usage

from atoma_sdk import AtomaSDK
import os

with AtomaSDK(
    bearer_auth=os.getenv("ATOMASDK_BEARER_AUTH", ""),
) as atoma_sdk:

    res = atoma_sdk.images.generate(model="black-forest-labs/FLUX.1-schnell", prompt="A cute baby sea otter floating on its back", n=1, quality="hd", response_format="url", size="1024x1024", style="vivid", user="user-1234")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
model str ✔️ The model to use for image generation. black-forest-labs/FLUX.1-schnell
prompt str ✔️ A text description of the desired image(s). The maximum length is 1000 characters. A cute baby sea otter floating on its back
n OptionalNullable[int] ➖ The number of images to generate. Defaults to 1. 1
quality OptionalNullable[str] ➖ The quality of the image that will be generated.
hd creates images with finer details and greater consistency across the image.		 hd
response_format OptionalNullable[str] ➖ The format in which the generated images are returned. url
size OptionalNullable[str] ➖ The size of the generated images. 1024x1024
style OptionalNullable[str] ➖ The style of the generated images. vivid
user OptionalNullable[str] ➖ A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. user-1234
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateImageResponse

Errors

Error Type Status Code Content Type
models.APIError 4XX, 5XX */*