Phala Cloud Documentation — Private AI on TEE

List available OS images

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images

const options = {method: 'GET'};

fetch('https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "version": [
      123
    ],
    "release": "<string>",
    "published_at": "2023-11-07T05:31:56Z",
    "prod": {
      "name": "<string>",
      "slug": "<string>",
      "requires_gpu": true,
      "supports_cpu": true,
      "supports_gpu": true,
      "enabled": true,
      "os_image_hash": "<string>",
      "is_current": false
    },
    "dev": {
      "name": "<string>",
      "slug": "<string>",
      "requires_gpu": true,
      "supports_cpu": true,
      "supports_gpu": true,
      "enabled": true,
      "os_image_hash": "<string>",
      "is_current": false
    }
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

cvms

{cvm_id}

available-os-images

List available OS images

curl --request GET \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images

const options = {method: 'GET'};

fetch('https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/available-os-images")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "version": [
      123
    ],
    "release": "<string>",
    "published_at": "2023-11-07T05:31:56Z",
    "prod": {
      "name": "<string>",
      "slug": "<string>",
      "requires_gpu": true,
      "supports_cpu": true,
      "supports_gpu": true,
      "enabled": true,
      "os_image_hash": "<string>",
      "is_current": false
    },
    "dev": {
      "name": "<string>",
      "slug": "<string>",
      "requires_gpu": true,
      "supports_cpu": true,
      "supports_gpu": true,
      "enabled": true,
      "os_image_hash": "<string>",
      "is_current": false
    }
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

cvm_id

string

required

Response

OS images grouped by version (newest first)

version

integer[]

required

Numeric compatibility version (major, minor, patch[, build])

Required array length: 3 - 4 elements

release

string

required

Full registered release label, including any rc suffix

published_at

string<date-time> | null

Upstream release timestamp

prod

OSImageVariant · object | null

Production build (stable)

Show child attributes

dev

OSImageVariant · object | null

Development build (testing)

Show child attributes