Skip to main content

GPT Image 2 text-to-image and edit-image client for RunAPI

Project description

GPT Image 2 Python SDK for RunAPI

The GPT Image 2 Python SDK is the language-specific package for GPT Image 2 on RunAPI. Use it for text-to-image and edit-image flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Python.

For model details, use https://runapi.ai/models/gpt-image-2; for API reference, use https://runapi.ai/docs#gpt-image-2; for SDK docs, use https://runapi.ai/docs#sdk-gpt-image-2.

Install

pip install runapi-gpt-image-2

Quick start

from runapi.gpt_image_2 import GptImage2Client

client = GptImage2Client()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."

task = client.text_to_image.create(
    model="gpt-image-2",
    prompt="A futuristic cityscape at night, cinematic",
    aspect_ratio="16:9",
    output_resolution="2k",
)
status = client.text_to_image.get(task.id)

edit = client.edit_image.create(
    model="gpt-image-2",
    prompt="Transform into oil painting style",
    source_image_urls=["https://example.com/source.jpg"],
)

Use create to submit a task and return quickly, get to fetch the latest task state, and run to create and poll until completion:

result = client.text_to_image.run(
    model="gpt-image-2",
    prompt="A serene mountain lake at dawn",
)
print(result.images[0].url)

In web request handlers, prefer create plus webhook or later get polling so a worker is not held open.

RunAPI-generated file URLs are temporary. Download and store generated images in your own durable storage within 7 days; do not treat returned URLs as long-term assets.

Language notes

Pass parameters as keyword arguments and catch the runapi.gpt_image_2 error classes when building image jobs or scripts. The available resources are text_to_image and edit_image. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

Links

License

Licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runapi_gpt_image_2-0.1.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runapi_gpt_image_2-0.1.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file runapi_gpt_image_2-0.1.0.tar.gz.

File metadata

  • Download URL: runapi_gpt_image_2-0.1.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.6

File hashes

Hashes for runapi_gpt_image_2-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ae1c70d04ae21f64fc93e994c7dfee700a2879a274cb6b5f3b7130001840e6c9
MD5 400974e35fbba122bfb17f7be1dd105b
BLAKE2b-256 141dc888555ab2dc3811b145456ce442147b1a2f116d119ebbe3b388e501f1fa

See more details on using hashes here.

File details

Details for the file runapi_gpt_image_2-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for runapi_gpt_image_2-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd2faca3c63e775ad8741e5a41668242353fb7b066da28c99a27f969944fc368
MD5 07a49b81bcd17e94c18ce23fa6527302
BLAKE2b-256 6f512ab19c77177486a8d961c6b6925a153301e9c2451faa23da11594244f49a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page