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_datasets API

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

Ideogram subpackage_datasets 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_datasets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.

This API exposes 4 operations across 3 paths, and defines 11 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.

4 operations 3 paths 11 schemas 2 GET2 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_datasets 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 4

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

subpackage_datasets 4
GET
/datasets
List datasets
list-datasets 1 param → 200401
POST
/datasets
Create a new dataset
create-dataset 1 param body → 200400401
GET
/datasets/{dataset_id}
Get a dataset
get-dataset 2 params → 200401404
POST
/datasets/{dataset_id}/upload_assets
Upload assets to a dataset
upload-dataset-assets 2 params body → 200400401404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Dataset (5 properties), UploadDatasetAssetsResponse (5 properties), GetDatasetResponse (4 properties), AssetIdentifier (2 properties). Each schema is shown below with its type and property counts.

CreateDatasetRequest
object
1 property 1 required
DatasetFile
object
A file in a dataset.
2 properties 1 required
DatasetUploadFailedAsset
object
2 properties 1 required
Dataset
object
A dataset for organizing training images.
5 properties 4 required
DatasetAssetFailureReason
string
Reason why an asset failed to upload.
AssetType
string
DatasetUploadSucceededAsset
object
2 properties 1 required
UploadDatasetAssetsResponse
object
5 properties 3 required
ListDatasetsResponse
object
1 property 1 required
AssetIdentifier
object
An identifier for an ideogram asset.
2 properties 2 required
GetDatasetResponse
object
Detailed view of a dataset, including its files.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Ideogram publishes across the network.

Ideogram subpackage_generate API
Ideogram subpackage_models API
Ideogram subpackage_vision API