API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Uploads

Create

POST/uploads

Retrieve

GET/uploads/{uploadId}

Trigger Action

POST/uploads/{uploadId}/action

ModelsExpand Collapse

UploadCreateResponse object { upload }

upload: object { id, authorId, createdAt, 18 more }

id: string

authorId: string

createdAt: string

fileName: string

kind: "3d" or "asset" or "audio" or 4 more

The kind of the file once validated (example: “model”)

One of the following:

"3d"

"asset"

"audio"

"avatar"

"image"

"model"

"video"

ownerId: string

source: "civitai" or "huggingface" or "multipart" or 2 more

One of the following:

"civitai"

"huggingface"

"multipart"

"other"

"url"

status: "complete" or "failed" or "imported" or 3 more

One of the following:

"complete"

"failed"

"imported"

"pending"

"validated"

"validating"

updatedAt: string

assetOptions: optional object { collectionIds, hide, parentId }

collectionIds: optional array of string

The collection ids to add the asset to.

hide: optional boolean

Specify if the asset should be hidden from the user.

parentId: optional string

The parentId of the asset.

config: optional unknown

contentType: optional string

entityId: optional string

errorMessage: optional string

fileSize: optional number

jobId: optional string

originalFileName: optional string

parts: optional array of object { expires, number, url }

expires: string

number: number

url: string

partsCount: optional number

provider: optional "civitai" or "huggingface" or "other"

One of the following:

"civitai"

"huggingface"

"other"

url: optional string

UploadRetrieveResponse object { upload }

upload: object { id, authorId, createdAt, 18 more }

id: string

authorId: string

createdAt: string

fileName: string

kind: "3d" or "asset" or "audio" or 4 more

The kind of the file once validated (example: “model”)

One of the following:

"3d"

"asset"

"audio"

"avatar"

"image"

"model"

"video"

ownerId: string

source: "civitai" or "huggingface" or "multipart" or 2 more

One of the following:

"civitai"

"huggingface"

"multipart"

"other"

"url"

status: "complete" or "failed" or "imported" or 3 more

One of the following:

"complete"

"failed"

"imported"

"pending"

"validated"

"validating"

updatedAt: string

assetOptions: optional object { collectionIds, hide, parentId }

collectionIds: optional array of string

The collection ids to add the asset to.

hide: optional boolean

Specify if the asset should be hidden from the user.

parentId: optional string

The parentId of the asset.

config: optional unknown

contentType: optional string

entityId: optional string

errorMessage: optional string

fileSize: optional number

jobId: optional string

originalFileName: optional string

parts: optional array of object { expires, number, url }

expires: string

number: number

url: string

partsCount: optional number

provider: optional "civitai" or "huggingface" or "other"

One of the following:

"civitai"

"huggingface"

"other"

url: optional string

UploadTriggerActionResponse object { upload }

upload: object { id, authorId, createdAt, 18 more }

id: string

authorId: string

createdAt: string

fileName: string

kind: "3d" or "asset" or "audio" or 4 more

The kind of the file once validated (example: “model”)

One of the following:

"3d"

"asset"

"audio"

"avatar"

"image"

"model"

"video"

ownerId: string

source: "civitai" or "huggingface" or "multipart" or 2 more

One of the following:

"civitai"

"huggingface"

"multipart"

"other"

"url"

status: "complete" or "failed" or "imported" or 3 more

One of the following:

"complete"

"failed"

"imported"

"pending"

"validated"

"validating"

updatedAt: string

assetOptions: optional object { collectionIds, hide, parentId }

collectionIds: optional array of string

The collection ids to add the asset to.

hide: optional boolean

Specify if the asset should be hidden from the user.

parentId: optional string

The parentId of the asset.

config: optional unknown

contentType: optional string

entityId: optional string

errorMessage: optional string

fileSize: optional number

jobId: optional string

originalFileName: optional string

parts: optional array of object { expires, number, url }

expires: string

number: number

url: string

partsCount: optional number

provider: optional "civitai" or "huggingface" or "other"

One of the following:

"civitai"

"huggingface"

"other"

url: optional string