runapi-ideogram-v3 0.1.0

Ideogram V3 image generation client for RunAPI

Ideogram V3 Python SDK for RunAPI

The Ideogram V3 Python SDK is the language-specific package for Ideogram V3 on RunAPI. Use it for text-to-image, edit-image, remix-image, and reframe-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/ideogram-v3; for API reference, use https://runapi.ai/docs#ideogram-v3; for SDK docs, use https://runapi.ai/docs#sdk-ideogram-v3.

Install

pip install runapi-ideogram-v3

Quick start

from runapi.ideogram_v3 import IdeogramV3Client

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

task = client.text_to_image.create(
    model="ideogram-v3-text-to-image",
    prompt="A cinematic lakeside at twilight",
    aspect_ratio="16:9",
    rendering_speed="quality",
)
status = client.text_to_image.get(task.id)

edit = client.edit_image.create(
    model="ideogram-v3-edit",
    prompt="Replace the sky with aurora",
    source_image_url="https://example.com/source.jpg",
    mask_url="https://example.com/mask.png",
)

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="ideogram-v3-text-to-image",
    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 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.ideogram_v3 error classes when building image jobs or scripts. The available resources are text_to_image, edit_image, remix_image, and reframe_image. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

Links

• Model page: https://runapi.ai/models/ideogram-v3
• SDK docs: https://runapi.ai/docs#sdk-ideogram-v3
• Product docs: https://runapi.ai/docs#ideogram-v3
• Pricing and rate limits: https://runapi.ai/models/ideogram-v3
• Full catalog: https://runapi.ai/models

License

Licensed under the Apache License, Version 2.0.