Skip to main content

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 this package for image generation, image editing, and creative production workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Python.

This README is the Python package guide inside the public gpt-image-2-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/gpt-image-2; for API reference, use https://runapi.ai/docs/api/gpt-image-2/text-to-image; for SDK docs, use https://runapi.ai/docs/resources/sdks.

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://cdn.runapi.ai/public/samples/image.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, videos, audio, or other files 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.

License

Licensed under the Apache License, Version 2.0.

Metadata

Release files for runapi-gpt-image-2 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for runapi-gpt-image-2 0.3.0
File Size Uploaded
runapi_gpt_image_2-0.3.0.tar.gz 4.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for runapi-gpt-image-2 0.3.0
File Interpreter ABI Platform
runapi_gpt_image_2-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.2 kB

Release files / runapi_gpt_image_2-0.3.0.tar.gz

Download URL runapi_gpt_image_2-0.3.0.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e694bc654c56e97ef44c77ae773b4e17b746454ebece79bce50ab5a54a1a49d5
BLAKE2b-256 checksum
How to use checksums
c1b02aae8c6de214bfe9a6899aec1e40e284f99100a21ad9c25eec25656dedd2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Omarchy","version":"4.0.1","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / runapi_gpt_image_2-0.3.0-py3-none-any.whl

Download URL runapi_gpt_image_2-0.3.0-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
06993656bf738a587d39ba8b37ee7aa75792dd01e41e133309b3d7cddbda5294
BLAKE2b-256 checksum
How to use checksums
59330a5d68c453d6d3cd54c755a9c143da1678c6f4f28377b8bcd139d1755c48
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Omarchy","version":"4.0.1","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page