Skip to main content

Z-Image Python SDK for RunAPI

The Z-Image Python SDK is the language-specific package for Z-Image on RunAPI. Use it for text-to-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/z-image; for API reference, use https://runapi.ai/docs#z-image; for SDK docs, use https://runapi.ai/docs#sdk-z-image.

Install

pip install runapi-z-image

Quick start

from runapi.z_image import ZImageClient

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

task = client.text_to_image.create(
    model="z-image",
    prompt="A neon city street after rain, cinematic",
    aspect_ratio="16:9",
)
status = client.text_to_image.get(task.id)

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="z-image",
    prompt="A serene mountain lake at dawn",
    aspect_ratio="1:1",
)
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.z_image error classes when building image jobs or scripts. The available resource is text_to_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.

Download files

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

Source Distribution

runapi_z_image-0.1.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

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

runapi_z_image-0.1.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runapi_z_image-0.1.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"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_z_image-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e32aa587bc84e9463b7ca87778ae0e0fac683cf787be81643908fb484c791068
MD5 773897d03e6d498b4cb402fcb0eab8f0
BLAKE2b-256 e20562be001f2f7f7583cbfafa1c923197b630aae39639c2904a312364c7f6b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runapi_z_image-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"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_z_image-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 85fbb3ac6226185b13644e89ded29ea451c7baa9c143de8187d5b9879f8760b7
MD5 e7ebaffd57206f7ef3f94211388a7963
BLAKE2b-256 ee7245a0b5b30de65f753999432f406f3cf34aeb5a96b487405f745a1f1dcd4a

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.1

2 files

0.2.0

2 files

This release

0.1.0 This release

2 files

Supported by

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