---
title: "List Assets"
method: GET
path: "/v1/assets"
tags: ["assets"]
---

# List Assets

`GET /v1/assets`

List assets with optional filtering.

## Query parameters

- `name` string, nullable — Filter based on asset name.
- `is_public` boolean — Filter based on asset visibility.
- `data_type` 'fp16' | 'fp32' | 'int4' | 'int8' — Data type for the asset.
- `asset_type` AssetType[] — Filter based on engine type.
- `engine` BaseEngine[] — Filter based on engine.
- `engine_type` 'text' | 'image' | 'audio' | 'video' — Base Engine types supported by asset library.
- `limit` integer — Max number of assets to return.
- `offset` integer — Offset to start listing assets.
- `get_preview_urls` boolean — Include preview URLs for assets.
- `asset_ids` string, nullable — Filter based on asset IDs.
- `owner` string, nullable — Filter based on asset owener.
- `file_format` union[] — Filter based on file format.
  - union
    - 'safetensors' | 'pt' — File format for the asset.
    - 'unknown' | 'png' | 'jpg' | 'jpeg' | 'txt' | 'mp3' | 'wav' | 'jsonl' — File extension supported for the asset.

## Response `200`

Successful Response

- ListAssetsResponse — List assets response.
  - `data` Asset[], required — List of retrieved assets.
    - `asset_type` 'file' | 'checkpoint' | 'lora' | 'textual_inversion' | 'vae' | 'latent', required — Asset type. It is used to distinguish between different supported assets.
    - `created_at` string, required — Asset creation time.
    - `data` union, required — Asset data. It shows the type of data for an asset.
      - FileData — Data class for `file` asset type.
        - `asset_type` 'file' — Asset type. It is used to distinguish between different supported assets.
        - `file_format` 'unknown' | 'png' | 'jpg' | 'jpeg' | 'txt' | 'mp3' | 'wav' | 'jsonl' — File extension supported for the asset.
        - `preview_url` string, nullable — Preview URL for this asset.
        - `version` string — Asset version. Default value is empty.
      - CheckpointData — Data class for `checkpoint` asset type.
        - `asset_type` 'checkpoint' — Asset type. It is used to distinguish between different supported assets.
        - `data_type` 'fp16' | 'fp32' | 'int4' | 'int8' — Data type for the asset.
        - `engine` 'text/llama-2-7b' | 'text/llama-2-13b' | 'text/llama-2-70b' | 'text/llama-3-8b' | 'text/llama-3-70b' | 'text/codellama-7b' | 'text/codellama-13b' | 'text/codellama-34b' | 'text/codellama-70b' | 'text/mistral-7b' | 'text/mistral-nemo' | 'text/mixtral-8x7b' | 'text/llama-3.1-8b' | 'text/llama-3.1-70b' | 'text/llama-3.1-405b' | 'image/controlnet-sd15' | 'image/controlnet-sdxl' | 'image/stable-diffusion-v1-5' | 'image/stable-diffusion-xl-v1-0' | 'image/stable-diffusion-v3-medium' | 'image/stable-diffusion-ssd' | 'image/flux-dev' | 'image/flux-schnell' | 'audio/tortoise-tts' | 'audio/rvc' | 'video/svd', required — Base Engine names supported by asset library.
        - `file_format` 'safetensors' | 'pt' — File format for the asset.
      - LoraData — Data class for `lora` asset type.
        - `asset_type` 'lora' — Asset type. It is used to distinguish between different supported assets.
        - `checkpoint` string, nullable — Base checkpoint used with LoRA.
        - `data_type` 'fp16' | 'fp32' | 'int4' | 'int8' — Data type for the asset.
        - `engine` 'text/llama-2-7b' | 'text/llama-2-13b' | 'text/llama-2-70b' | 'text/llama-3-8b' | 'text/llama-3-70b' | 'text/codellama-7b' | 'text/codellama-13b' | 'text/codellama-34b' | 'text/codellama-70b' | 'text/mistral-7b' | 'text/mistral-nemo' | 'text/mixtral-8x7b' | 'text/llama-3.1-8b' | 'text/llama-3.1-70b' | 'text/llama-3.1-405b' | 'image/controlnet-sd15' | 'image/controlnet-sdxl' | 'image/stable-diffusion-v1-5' | 'image/stable-diffusion-xl-v1-0' | 'image/stable-diffusion-v3-medium' | 'image/stable-diffusion-ssd' | 'image/flux-dev' | 'image/flux-schnell' | 'audio/tortoise-tts' | 'audio/rvc' | 'video/svd', required — Base Engine names supported by asset library.
        - `file_format` 'safetensors' | 'pt' — File format for the asset.
        - `trigger_words` string[], nullable — Trigger words used for tuning.
      - TextualInversionData — Data class for `textual_inversion` asset type.
        - `asset_type` 'textual_inversion' — Asset type. It is used to distinguish between different supported assets.
        - `data_type` 'fp16' | 'fp32' | 'int4' | 'int8' — Data type for the asset.
        - `engine` 'text/llama-2-7b' | 'text/llama-2-13b' | 'text/llama-2-70b' | 'text/llama-3-8b' | 'text/llama-3-70b' | 'text/codellama-7b' | 'text/codellama-13b' | 'text/codellama-34b' | 'text/codellama-70b' | 'text/mistral-7b' | 'text/mistral-nemo' | 'text/mixtral-8x7b' | 'text/llama-3.1-8b' | 'text/llama-3.1-70b' | 'text/llama-3.1-405b' | 'image/controlnet-sd15' | 'image/controlnet-sdxl' | 'image/stable-diffusion-v1-5' | 'image/stable-diffusion-xl-v1-0' | 'image/stable-diffusion-v3-medium' | 'image/stable-diffusion-ssd' | 'image/flux-dev' | 'image/flux-schnell' | 'audio/tortoise-tts' | 'audio/rvc' | 'video/svd', required — Base Engine names supported by asset library.
        - `file_format` 'safetensors' | 'pt' — File format for the asset.
        - `trigger_words` string[] — Trigger words using for tuning.
      - VAEData — Data class for `vae` asset type.
        - `asset_type` 'vae' — Asset type. It is used to distinguish between different supported assets.
        - `data_type` 'fp16' | 'fp32' | 'int4' | 'int8' — Data type for the asset.
        - `engine` 'text/llama-2-7b' | 'text/llama-2-13b' | 'text/llama-2-70b' | 'text/llama-3-8b' | 'text/llama-3-70b' | 'text/codellama-7b' | 'text/codellama-13b' | 'text/codellama-34b' | 'text/codellama-70b' | 'text/mistral-7b' | 'text/mistral-nemo' | 'text/mixtral-8x7b' | 'text/llama-3.1-8b' | 'text/llama-3.1-70b' | 'text/llama-3.1-405b' | 'image/controlnet-sd15' | 'image/controlnet-sdxl' | 'image/stable-diffusion-v1-5' | 'image/stable-diffusion-xl-v1-0' | 'image/stable-diffusion-v3-medium' | 'image/stable-diffusion-ssd' | 'image/flux-dev' | 'image/flux-schnell' | 'audio/tortoise-tts' | 'audio/rvc' | 'video/svd', required — Base Engine names supported by asset library.
        - `file_format` 'safetensors' | 'pt' — File format for the asset.
      - LatentData — Data class for `latent` asset type.
        - `asset_type` 'latent' — Asset type. It is used to distinguish between different supported assets.
        - `engine` 'text/llama-2-7b' | 'text/llama-2-13b' | 'text/llama-2-70b' | 'text/llama-3-8b' | 'text/llama-3-70b' | 'text/codellama-7b' | 'text/codellama-13b' | 'text/codellama-34b' | 'text/codellama-70b' | 'text/mistral-7b' | 'text/mistral-nemo' | 'text/mixtral-8x7b' | 'text/llama-3.1-8b' | 'text/llama-3.1-70b' | 'text/llama-3.1-405b' | 'image/controlnet-sd15' | 'image/controlnet-sdxl' | 'image/stable-diffusion-v1-5' | 'image/stable-diffusion-xl-v1-0' | 'image/stable-diffusion-v3-medium' | 'image/stable-diffusion-ssd' | 'image/flux-dev' | 'image/flux-schnell' | 'audio/tortoise-tts' | 'audio/rvc' | 'video/svd', required — Base Engine names supported by asset library.
        - `file_format` 'safetensors' | 'pt' — File format for the asset.
    - `description` string, required — Asset description. It is used to provide more information.
    - `file_structure` 'unknown' | 'single_file' | 'multiple_files' — File structure for the asset.
    - `hf_repo` string, nullable — Hugging Face repository.
    - `id` string, required — Asset id. A unique identifier for the asset.
    - `is_public` boolean — True if asset is public.
    - `name` string, required — Asset name. A unique name for the asset.
    - `size_bytes` integer, required — Asset size in bytes.
    - `status` 'ready_to_upload' | 'uploaded' | 'ready' | 'deleted' | 'rejected' | 'error' | 'uploading', required — Status of an asset in asset library.
    - `status_details` string, required — Asset status details.
    - `status_info` object — Asset status info. Provides extra information about the asset.
    - `tenant_uuid` string, uuid, required — Asset tenant ID. This is unique for each OctoAI user.
    - `url` string, uri, nullable — A unique URL for the asset.
  - `has_more` boolean, required — True if there are more asset to show.
  - `total` integer, required — Total number of assets.

## Other responses

- `422` — Validation Error

## Changes

- **2024-09-09** `b157279528e4` — 44 warning, 10 info
  - for the `query` request parameter `limit`, the max was set to `100.00`
  - for the `query` request parameter `limit`, the min was set to `1.00`
  - for the `query` request parameter `offset`, the min was set to `0.00`
  - added the new `image/flux-dev` enum value to the `data/items/data/oneOf[subschema #2: CheckpointData]/engine/allOf[subschema #1: BaseEngine]/` response property for the response status `200`
  - …50 more
- **2024-06-05** `f62e8bbe2b1d` — 1 breaking, 16 warning, 3 info
  - the `data/items/asset_type` response's property type changed from no type to `string` for status `200`
  - added the new `checkpoint` enum value to the `data/items/asset_type` response property for the response status `200`
  - added the new `file` enum value to the `data/items/asset_type` response property for the response status `200`
  - added the new `latent` enum value to the `data/items/asset_type` response property for the response status `200`
  - …16 more
- …earlier changes not shown

[Full history](https://skmtc.dev/octoml/apis/asset-library-api/changes/v1/assets/get.md)

---

[API](https://skmtc.dev/octoml/apis/asset-library-api.md) · [All operations](https://skmtc.dev/octoml/apis/asset-library-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/octoml/asset-library-api/revisions/b157279528e4/schema)
