Ideogram API

Hosted Ideogram image generation and editing with strong in-image text rendering.

Provider: default
Kind: AI service
Category: Compute
Official docs: https://developer.ideogram.ai/ideogram-api/api-overview

Properties · 4 set by this component

property	type	values	required	kind default	this component
apiVersion · component property	enum	v2 \| v1	no	v2	inherited
asyncMode · component property	boolean	—	no	false	inherited
auth	enum	api-key \| oauth \| iam \| none	no	—	▸ api-key
contentFiltering	boolean	—	no	—	inherited
customerManagedKeys	boolean	—	no	—	inherited
dataResidency · advanced	enum	us \| eu \| asia \| global	no	—	inherited
dataRetentionDays	integer	—	no	—	inherited
keyStore	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
maxConcurrentRequests · component property	integer	—	no	10	inherited
modality	enum	text \| vision \| speech \| multimodal \| structured \| image \| video \| audio \| embedding \| rerank	no	—	▸ image
publicEndpoint	boolean	—	no	—	▸ true
quotaUnitsPerMinute	integer	—	no	—	inherited
rateLimitRpm · advanced	integer	—	no	—	inherited
rateLimitTpm · advanced	integer	—	no	—	inherited
viaGateway	boolean	—	no	false	inherited

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

AI API key not managedwarning

ai-api-key-unmanaged

This AI vendor is reached with an API key, and nothing in the design holds or rotates that key. It ends up in environment files or code, every caller shares it, and a single leak runs up the vendor bill until someone notices. Put the key in a key-management component, or say it is held there with keyStore.

— all of these hold:
— the node's `auth` is "api-key"
— the node's `keyStore` is false
— the node has at least one incoming edge from an app-server, worker or client
— this does not hold:
— the design contains a node of kind key-management

Stateful node without zone redundancyerror

stateful-node-without-zone-redundancy

A stateful compute node pinned to exactly one availability zone disappears with that zone, and its state goes with it. Nodes inside a cell are exempt, because there the cell is deliberately single-zone and redundancy comes from the other cells.

— all of these hold:
— the node's `stateless` is false
— the node sits inside exactly 1 availability-zone group
— this does not hold:
— the node sits inside at least one cell group

Use it in a design

nodes:
  - { id: "ideogram-api", component: "ideogram-api" }

Other AI service products · 125

and 85 more → AI service page

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Ideogram API: hosted Ideogram image generation and editing (strong in-image text), plus upscale and video tools.
3# Per "API Overview", the default limit is 10 concurrent in-flight requests and returned image URLs expire,
4# so results must be downloaded; image endpoints are synchronous unless async or a webhook_url is set.
5schemaVersion: "1"
6type: "component"
7id: "ideogram-api"
8kind: "ai-service"
9provider: "default"
10docs: "https://developer.ideogram.ai/ideogram-api/api-overview"
11defaults:
12  auth: "api-key"
13  managed: true
14  modality: "image"
15  publicEndpoint: true
16properties:
17  maxConcurrentRequests:
18    type: "integer"
19    default: 10
20  apiVersion:
21    type: "enum"
22    values: ["v2", "v1"]
23    default: "v2"
24  asyncMode:
25    type: "boolean"
26    default: false

The same page as markdown, for an agent: /catalogue/components/ideogram-api.md