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.4.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.4.0
File Size Uploaded Provenance Actions
runapi_gpt_image_2-0.4.0.tar.gz 4.4 kB Without provenance Details for runapi_gpt_image_2-0.4.0.tar.gz

Built distribution (wheel)

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

Total release size: 10.3 kB

Release files / runapi_gpt_image_2-0.4.0.tar.gz

Download URL runapi_gpt_image_2-0.4.0.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
562325b19697ea1f0d3da190a43e2869e706f4d1ab249e9b435b5cc8d6573415
BLAKE2b-256 checksum
How to use checksums
6c94df9433e12f895306e97f9c9bb8a88f93e734edabc707d85f88799e82dc80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"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.4.0-py3-none-any.whl

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

Security for runapi-gpt-image-2 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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