Inference Logoinference.sh
apps/pruna/p-image-ideogram

p-image-ideogram

High-quality text-to-image generation with strong typography and prompt understanding, built with Ideogram

run in browser run via API
run with your agent
# install belt
$curl -fsSL https://cli.inference.sh | sh
# view schema & details
$belt app get pruna/p-image-ideogram
# run
$belt app run pruna/p-image-ideogram

api reference

about

high-quality text-to-image generation with strong typography and prompt understanding, built with ideogram

1. calling the api

install the client

the client provides a convenient way to interact with the api.

bash
1pip install inferencesh

setup your api key

set INFERENCE_API_KEY as an environment variable. get your key from settings → api keys.

bash
1export INFERENCE_API_KEY="inf_your_key"

run and get result

submit a request and wait for the final result. best for batch processing or when you don't need progress updates.

python
1from inferencesh import inference23client = inference()456result = client.run({7        "app": "pruna/p-image-ideogram",8        "input": {}9    })1011print(result["output"])

stream live updates

get real-time progress updates as the task runs. ideal for showing progress bars, partial results, or long-running tasks.

python
1from inferencesh import inference23client = inference()456# stream=True yields updates as they arrive7for update in client.run({8        "app": "pruna/p-image-ideogram",9        "input": {}10    }, stream=True):11    if update.get("progress"):12        print(f"progress: {update['progress']}%")13    if update.get("output"):14        print(f"output: {update['output']}")

2. authentication

the api uses api keys for authentication. see the authentication docs for detailed setup instructions.

3. files

file inputs are automatically handled by the sdk. you can pass local paths, urls, or base64 data.

automatic upload

the python sdk automatically detects local file paths and uploads them. urls are passed through as-is.

python
1# local file paths are automatically uploaded2result = client.run({3    "app": "pruna/p-image-ideogram",4    "input": {5        "image": "/path/to/local/image.png",  # detected & uploaded6        "audio": "https://example.com/audio.mp3",  # url passed through7    }8})

manual upload

you can also upload files manually and use the returned url.

python
1# upload and get a hosted URL2file = client.files.upload("/path/to/file.png")3print(file.uri)  # https://cloud.inference.sh/...

4. webhooks

get notified when a task completes by providing a webhook url. when the task reaches a terminal state (completed, failed, or cancelled), a POST request is sent to your url with the task result.

python
1result = client.run({2    "app": "pruna/p-image-ideogram",3    "input": {},4    "webhook": "https://your-server.com/webhook"5}, wait=False)

webhook payload

your endpoint receives a JSON POST with the task result:

json
1{2  "id": "task_abc123",3  "status": 9,4  "output": { ... },5  "error": "",6  "session_id": null,7  "created_at": "2024-01-15T10:30:00Z",8  "updated_at": "2024-01-15T10:30:05Z"9}
idstring— task id
statusnumber— terminal status (9=completed, 10=failed, 11=cancelled)
outputobject— task output (when completed)
errorstring— error message (when failed)
session_idstring— session id (if using sessions)
created_atstring— iso timestamp
updated_atstring— iso timestamp

5. schema

input

promptstring*

text description of the image to generate. handles rendered text and typography well.

thinkingstring

reasoning effort. higher levels improve quality at the cost of speed and price.

default: "high"
options:"very low""low""medium""high"
image_sizestring

output resolution budget. ignored when aspect_ratio is custom.

default: "1K"
options:"1K""2K"
aspect_ratiostring

aspect ratio for the image. use custom to set width and height directly.

default: "1:1"
options:"1:1""16:9""9:16""4:3""3:4""3:2""2:3""custom"
widthinteger

custom width in pixels (256-2560). only used when aspect_ratio=custom.

min:256max:2560
heightinteger

custom height in pixels (256-2560). only used when aspect_ratio=custom.

min:256max:2560
prompt_upsamplingboolean

enhance the prompt with an llm before generation.

default: true
seedinteger

random seed for reproducible generation.

output_formatstring

output image format.

default: "jpg"
options:"jpg""png""webp"
output_qualityinteger

output quality from 0 to 100. ignored for png.

default: 80min:0max:100

output

imagestring(file)*

generated image file.

seedinteger

seed used for generation.

ready to run p-image-ideogram?

try in browserbrowse all tools

we use cookies

we use cookies to ensure you get the best experience on our website. for more information on how we use cookies, please see our cookie policy.

by clicking "accept", you agree to our use of cookies.
learn more.