Skip to main content

RunAPI GPT Image 2 SDK for text-to-image and image editing workflows in JavaScript, Python, Ruby, Go, Java, and PHP

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 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#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://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.

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.2.0.tar.gz (4.7 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.2.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runapi_gpt_image_2-0.2.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_gpt_image_2-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3e2463b532403c16879afe1993aaec6c16647dd878a516059b2e6091e4953b63
MD5 8b2505c8361874061cae16fa0b040946
BLAKE2b-256 da4b82f93a17136299f47c8b09a1f38f50649937bb709af689033ce1d1f6cdd0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runapi_gpt_image_2-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_gpt_image_2-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7dc83d4afcaa2aefbc7262cd32c0dd1c3c4d1e1235c9f5d556ee2d049c5a8433
MD5 bd9e1cff0dd0dd7de0a5a05925d672cc
BLAKE2b-256 16f6c11f22de93858c19dbc7cec240e083780912e05a0e83545173f6277ff4c0

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