Ideogram Describe Serverless API

Ideogram describe can effortlessly generate detailed prompts from images. Perfect for refining creations or replicating styles.

PlaygroundAPI
Pricing
~3.89s
POST /v2/ideogram-describe · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "ideogram-describe",
 9    image_file="https://segmind-resources.s3.amazonaws.com/input/3446e9ea-6e3d-4ab6-9404-ae033db56625-ideogram-describe-ip.webp",
10)
11print(result["status"])                      # COMPLETED
12print(result.get("output"))                  # model output (e.g. media URL)
13print(result["metrics"]["inference_time"])   # server compute seconds
14
15# --- Or submit + poll manually (track request_id, control the cadence) ---
16from segmind import SegmindClient, InferenceFailed, InferenceTimeout
17
18client = SegmindClient()                      # reads SEGMIND_API_KEY
19payload = {
20    "image_file": "https://segmind-resources.s3.amazonaws.com/input/3446e9ea-6e3d-4ab6-9404-ae033db56625-ideogram-describe-ip.webp",
21}
22job = client.submit_async("ideogram-describe", **payload)
23print(job.request_id)                         # available immediately
24try:
25    result = job.wait(timeout=600, interval=1.0)
26except InferenceTimeout as e:
27    print("still running:", e.request_id)
28except InferenceFailed as e:
29    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/ideogram-describe

Parameters

image_filerequired
string (uri)

https://segmind-resources.s3.amazonaws.com/input/3446e9ea-6e3d-4ab6-9404-ae033db56625-ideogram-describe-ip.webp

Response Type

Returns: Text/JSON

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/ideogram-describe

    Submit — returns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Poll — until COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Result — final response body

Status states

QUEUED— Accepted, waiting for a worker
PROCESSING— Running on a worker
COMPLETED— Done — result body is ready
FAILED— Errored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out