Skip to content

runapi-ai/z-image-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

RunAPI

Z-Image API SDKs for JavaScript, Python, Ruby, Go, and Java on RunAPI.

npm PyPI RubyGems Go Reference Maven Central License


The Z-Image API SDK packages JavaScript, Python, Ruby, Go, and Java clients for Z-Image on RunAPI. Use it for text-to-image workflows when your app needs typed request builders, predictable task polling, file upload helpers, account helpers, and consistent RunAPI errors.

Z-Image is listed in the RunAPI model catalog at https://runapi.ai/models/z-image. Variant pages below carry pricing, rate-limit, and commercial-usage details. The public z-image-sdk repository groups the language packages, examples, CI, and release tags for this model.

Install

npm install @runapi.ai/z-image
pip install runapi-z-image
gem install runapi-z_image
go get github.com/runapi-ai/z-image-sdk/go@latest

Gradle:

dependencies {
  implementation("ai.runapi:runapi-z-image:0.1.0")
}

Maven:

<dependency>
  <groupId>ai.runapi</groupId>
  <artifactId>runapi-z-image</artifactId>
  <version>0.1.0</version>
</dependency>

Use the Java BOM when installing multiple RunAPI Java modules:

dependencies {
  implementation(platform("ai.runapi:runapi-bom:0.1.0"))
  implementation("ai.runapi:runapi-z-image")
}

What you can build

  • Build apps, agent workflows, batch jobs, and production services around Z-Image requests.
  • Install only the language package your app needs while keeping one model-specific repository for docs and releases.
  • Use create for submit-only jobs, get for status lookup, and run for submit-and-poll scripts.
  • Upload local files, URL files, or base64 files through shared RunAPI file helpers.
  • Handle validation, authentication, rate limits, insufficient credits, task failures, and polling timeouts through RunAPI SDK errors.

Java quick start

import ai.runapi.zimage.ZImageClient;
import ai.runapi.zimage.types.TextToImageParams;
import ai.runapi.zimage.types.CompletedTextToImageResponse;
import ai.runapi.zimage.types.TextToImageModel;

ZImageClient client = ZImageClient.builder()
    .apiKey(System.getenv("RUNAPI_API_KEY"))
    .build();

CompletedTextToImageResponse result = client.textToImage().run(
    TextToImageParams.builder()
        .model(TextToImageModel.Z_IMAGE)
        .prompt("A bilingual poster with crisp typography")
        .aspectRatio("1:1")
        .build()
);

Java packages target Java 8 bytecode and are tested on Java 8, 11, 17, and 21. Each model artifact depends on ai.runapi:runapi-core, so application code normally installs only ai.runapi:runapi-z-image.

Task lifecycle

Most media endpoints are asynchronous. create() submits a task and returns its id, get(id) fetches the latest task state, and run(params) creates the task and polls until it reaches a terminal state. In web request handlers, prefer create() plus webhook or later get() polling so the server does not hold a worker open.

Repository layout

  • js/ publishes @runapi.ai/z-image.
  • python/ publishes runapi-z-image.
  • ruby/ publishes runapi-z_image when RubyGems publishing resumes.
  • go/ publishes github.com/runapi-ai/z-image-sdk/go and depends on github.com/runapi-ai/core-sdk/go.
  • java/ publishes ai.runapi:runapi-z-image and depends on ai.runapi:runapi-core.

Public links

Pricing and variants

Use the most specific Z-Image variant page for pricing, rate limits, and commercial usage:

Default pricing link for the Z-Image SDK: https://runapi.ai/models/z-image

File storage

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.

FAQ

Which package should I install for Z-Image work?

Install the model package for your language: @runapi.ai/z-image on npm, runapi-z-image on PyPI, runapi-z_image on RubyGems, github.com/runapi-ai/z-image-sdk/go, or ai.runapi:runapi-z-image. Install core SDK packages only when you are building shared SDK infrastructure.

Where should public links point?

Primary Z-Image links point to https://runapi.ai/models/z-image. Pricing and usage-policy links point to variant pages such as https://runapi.ai/models/z-image. Provider comparisons point to https://runapi.ai/providers/alibaba, and broad browsing points to https://runapi.ai/models.

License

Licensed under the Apache License, Version 2.0.