Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ideogram subpackage_models API

The subpackage_models API from Ideogram — 3 operation(s) for subpackage_models.

Ideogram subpackage_models API is one of 4 APIs that Ideogram publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.ideogram.ai.

3 operations 3 paths 7 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ideogram.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ideogram subpackage_models API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Key (ApiKeyAuth).

  • ApiKeyAuth — API key for access control. Use in the header with the name \"Api-Key\"

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_models 3
POST
/v1/ideogram-v3/train-model
Train a custom Ideogram v3 model
train-model-v-3 1 param body → 200400401404
GET
/models
List models
list-custom-models 3 params → 200401
GET
/models/{model_id}
Get model details
get-custom-model 2 params → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CustomModel (9 properties), TrainDatasetModelResponse (4 properties), TrainModelV3Request (2 properties), ListModelsResponse (1 property). Each schema is shown below with its type and property counts.

ModelsGetParametersScope
string
TrainDatasetModelResponse
object
4 properties 4 required
GetModelResponse
object
1 property 1 required
ListModelsResponse
object
1 property 1 required
ModelStatus
string
The status of a custom model.
TrainModelV3Request
object
Training request for a custom Ideogram v3 model using default hyperparameters.
2 properties 2 required
CustomModel
object
A custom model.
9 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ideogram-subpackage-models-api-openapi.yml Raw ↑

Other APIs Ideogram publishes across the network.

Ideogram subpackage_datasets API
Ideogram subpackage_generate API
Ideogram subpackage_vision API