Train a custom Ideogram v3 model | Ideogram

Start training a custom Ideogram v3 model from a dataset using default hyperparameters. The dataset must contain at least 15 images and a maximum of 100 images.

Authentication

Api-Keystring

API key for access control. Use in the header with the name “Api-Key”

Request

Training configuration

dataset_idstringRequired

ID of the dataset to train the model from.

model_namestringRequired

Name for the trained model. Must be 5-30 characters, alphanumeric with spaces and hyphens allowed.

Response

Training started successfully

model_idstring

Unique identifier of the created model.

dataset_idstring

Identifier of the dataset used for training.

training_statusstring

Current training status of the model.

model_namestring

Name of the model.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

API key for access control. Use in the header with the name “Api-Key”

Training configuration

ID of the dataset to train the model from.

Name for the trained model. Must be 5-30 characters, alphanumeric with spaces and hyphens allowed.

Training started successfully

Unique identifier of the created model.

Identifier of the dataset used for training.

Current training status of the model.

$	curl -X POST https://api.ideogram.ai/v1/ideogram-v3/train-model \
>	-H "Api-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"dataset_id": "abc123",
>	"model_name": "my-custom-model"
>	}'

1	{
2	"model_id": "model_id",
3	"dataset_id": "dataset_id",
4	"training_status": "training_status",
5	"model_name": "model_name"
6	}

$	curl -X POST https://api.ideogram.ai/v1/ideogram-v3/train-model \
>	-H "Api-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"dataset_id": "abc123",
>	"model_name": "my-custom-model"
>	}'

1	{
2	"model_id": "model_id",
3	"dataset_id": "dataset_id",
4	"training_status": "training_status",
5	"model_name": "model_name"
6	}