Sign in
file

Upload a new asset

Uploads a new asset to the system with associated metadata. Supports two upload methods:

  1. Direct file upload (multipart/form-data)
  2. URL-based upload (application/json with source: "url")

If an asset with the same hash already exists, returns the existing asset.

post/api/assets

Request body

namestring required

Display name for the asset (used to determine file extension)

preview_idstring uuid

Optional preview asset ID

tagsstring[]

Freeform tags for the asset. Common types include "models", "input", "output", and "temp", but any tag can be used in any order.

urlstring uri required

HTTP/HTTPS URL to download the asset from

user_metadataobject

Custom metadata to store with the asset

Response

Asset created successfully

asset_hashstring

Deprecated: use hash instead. Blake3 hash of the asset content.

created_atstring date-time required

Timestamp when the asset was created

display_namestring nullable

Display name of the asset. Mirrors name for backwards compatibility.

hashstring

Blake3 hash of the asset content. Preferred over asset_hash.

idstring uuid required

Unique identifier for the asset

is_immutableboolean

Whether this asset is immutable (cannot be modified or deleted)

job_idstring uuid nullable

ID of the job that created this asset, if available

last_access_timestring date-time

Timestamp when the asset was last accessed

metadataobject

System-managed metadata from download sources (HuggingFace, CivitAI, etc.) - read-only, not user-modifiable

mime_typestring

MIME type of the asset

namestring required

Name of the asset file

preview_idstring uuid nullable

ID of the preview asset if available

preview_urlstring uri

URL for asset preview/thumbnail

sizeinteger

Size of the asset in bytes

tagsstring[]

Tags associated with the asset

updated_atstring date-time required

Timestamp when the asset was last updated

user_metadataobject

Custom user metadata for the asset

created_newboolean required

Whether this was a new asset creation (true) or returned existing (false)

Changes