Get All OS Images

This endpoint retrieves the complete list of available OS container images pre-configured with CUDA drivers, deep learning frameworks (e.g., PyTorch), inference engines (e.g., vLLM for Qwen), and specialized AI toolchains (e.g., ComfyUI, Unsloth, SkyRL).

Get All OS Images - Overview

The Yotta Series OS Images API allows authenticated users to retrieve all available GPU pod image options that can be used to launch new pods.

The endpoint returns a list of available image identifiers along with the total image count, a descriptive message, and the response status.

Use this endpoint to review the available operating system and preconfigured software images before launching a Yotta Series GPU pod.

Endpoint

Property	Value
HTTP Method	GET
Endpoint	/yotta/images
Full URL	https://cloud.dataoorts.com/api/v1/yotta/images
Authentication	Bearer Token
Response Format	JSON

Authentication

This endpoint requires a valid Dataoorts Unify API key.

Include your API key in the Authorization header using the Bearer authentication scheme.

HTTP

Authorization: Bearer YOUR_API_KEY
Accept: application/json

Generate or manage your API key through the Dataoorts Unify API.

Keep your API key confidential and never expose it in public repositories or client-side applications.

Request Parameters

This endpoint does not require any query parameters or a request body. Send a GET request with the required authentication header.

Request Examples

cURL - Use the following command to retrieve all available Yotta Series pods images:

Bash

curl --request GET \
  --url "https://cloud.dataoorts.com/api/v1/yotta/images" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

Replace YOUR_API_KEY with your actual Dataoorts Unify API key.

Python Example Implementation

The following example uses the requests library to retrieve all available Yotta Series pod images and display the total image count and image identifiers.

Install the required dependency:

Bash

pip install requests

Python

import os
import requests


API_URL = "https://cloud.dataoorts.com/api/v1/yotta/images"


def get_yotta_images(api_key: str) -> dict:
    """
    Retrieve all available Yotta Series pod images.

    Args:
        api_key: Your Dataoorts Unify API key.

    Returns:
        dict: The JSON response containing available pod images.

    Raises:
        requests.exceptions.RequestException:
            If the HTTP request fails or returns an unsuccessful
            HTTP status code.
        ValueError:
            If the response is not JSON or cannot be decoded.
    """
    headers = {
        "Authorization": f"Bearer {api_key}",
        "Accept": "application/json",
    }

    response = requests.get(
        API_URL,
        headers=headers,
        timeout=60,
    )

    response.raise_for_status()

    content_type = response.headers.get("Content-Type", "")

    if "application/json" not in content_type.lower():
        raise ValueError(
            "The API returned a non-JSON response: "
            f"{response.text[:500]}"
        )

    try:
        return response.json()
    except requests.exceptions.JSONDecodeError as exc:
        raise ValueError(
            "The API returned an invalid JSON response."
        ) from exc


if __name__ == "__main__":
    api_key = os.getenv("DATAOORTS_API_KEY")

    if not api_key:
        raise RuntimeError(
            "Set the DATAOORTS_API_KEY environment variable."
        )

    try:
        result = get_yotta_images(api_key)

        print("Status:", result.get("status"))
        print("Message:", result.get("message"))
        print("Total Images:", result.get("count"))

        print("\nAvailable Yotta Pod Images")

        for image in result.get("images", []):
            print("-", image)

    except requests.exceptions.RequestException as exc:
        print(f"API request failed: {exc}.")

    except ValueError as exc:
        print(f"Invalid API response: {exc}.")

Set your API key before running the script.

Linux / macOS

Bash

export DATAOORTS_API_KEY="YOUR_API_KEY"
python yotta_images.py

Windows PowerShell

PowerShell

$env:DATAOORTS_API_KEY="YOUR_API_KEY"
python yotta_images.py

The script displays the total number of available images, followed by each image identifier returned by the API.

Example Success Response

A successful request returns a JSON object containing the total number of available images, the image identifiers, a descriptive message, and the response status.

JSON

{
  "count": 12,
  "images": [
    "pytorch:2.9.0-py3.11-cuda12.8.1-cudnn-devel-ubuntu22.04",
    "unsloth:0.6.9-py3.11-cuda12.1-cudnn-devel-ubuntu22.04",
    "miles:py3.11-cuda12.1-cudnn-devel-ubuntu22.04",
    "skyrl:ray2.51-py3.11-cuda12.1-cudnn-devel-ubuntu22.04",
    "comfyui:cuda12.8.1-ubuntu22.04-2025102101",
    "comfyui-nunchaku:cuda12.8.1-ubuntu22.04-2025102101",
    "qwen:vllm-cuda12.8.1-ubuntu22.04-2025102101",
    "wan2.2:comfyui-cuda12.8.1-ubuntu22.04-2025102101",
    "flux1.dev:comfyui-cuda12.8.1-ubuntu22.04-2025102101",
    "pytorch:2.8.0-py3.11-cuda12.8.1-cudnn-devel-ubuntu22.04-2025081902",
    "dflash:py3.11-cuda12.8.1-cudnn-devel-ubuntu22.04",
    "openclaw:py3.11-cuda12.8-cudnn-devel-ubuntu22.04"
  ],
  "message": "Available Yotta Pod images retrieved for you successfully.",
  "status": "success"
}

The values above illustrate the response structure. The number of available images and the returned image identifiers may differ in subsequent API responses.

Response Fields

Field	Type	Description
status	String	Indicates result of API req, Successful response return success.
message	String	A descriptive message about the result of the request.
count	Integer	Number of images included in the response.
images	Array of strings	Contains the identifiers of the available Yotta Series pod images.

Image Fields

Each item in the images array is a string representing an available pod image identifier.

Field	Type	Description
images[]	String	Image identifier that can be selected from available Pod image options.

Understanding Image Information

Available Pod Images

The images array contains the image identifiers returned by the API. The example response includes images for PyTorch, Unsloth, Miles, SkyRL, ComfyUI, Qwen, Wan 2.2, Flux, DFlash, and OpenClaw. These identifiers include software and version information as represented in the returned values.

Using Image Identifiers

Use this endpoint to review the available image options before launching a new Yotta Series pod. Select an image identifier from the returned images array when configuring a pod, according to the requirements of the relevant instance creation endpoint. Use the exact identifier returned by the API rather than assuming that an image name or version is available.

Important Notes

1. Authentication: A valid Dataoorts Unify API key is required to retrieve available pod images.

2. Request Parameters: This endpoint does not require query parameters or a request body.

3. Image Identifiers: The images array contains string identifiers. Preserve the complete identifier, including its version and other suffixes.

4. Pod Creation: This endpoint retrieves available image options; it does not launch or create a pod.

5. Available Images: Example response contains 12 images. Actual count and image list may change over time.

6. API Key Security: Keep your API key confidential and store it in the DATAOORTS_API_KEY environment variable rather than hardcoding it in your application.

Error Handling

If the request fails, the API may return an unsuccessful HTTP status code or a response that does not match the expected JSON format.

Your application should handle authentication failures, network errors, request timeouts, server errors, and unexpected response formats. The exact error codes and messages depend on the API response.

In Python, response.raise_for_status() raises an exception for unsuccessful HTTP status codes. Example also checks the response content type and handles JSON decoding errors before processing the image list.

Scenario	Recommended Handling
API key is missing	Set the DATAOORTS_API_KEY environment variable.
Authentication fails	Verify that the API key is valid and included in the Authorization header.
HTTP request fails	Catch requests.exceptions.RequestException and inspect the error details.
Response is not JSON	Inspect the returned response text without attempting to parse it as JSON.
Response contains invalid JSON	Handle the JSON decoding error before accessing response fields.
No images are returned	Check count and images fields before processing the results.

Get Help and Support

For assistance with Yotta pods images or API integration, Contact the support team at [email protected].