Skip to content
Scenario Docs
Get started
API Reference

Uploads

Create
uploads.create(UploadCreateParams**kwargs) -> UploadCreateResponse
POST/uploads
Retrieve
uploads.retrieve(strupload_id) -> UploadRetrieveResponse
GET/uploads/{uploadId}
Trigger Action
uploads.trigger_action(strupload_id, UploadTriggerActionParams**kwargs) -> UploadTriggerActionResponse
POST/uploads/{uploadId}/action
ModelsExpand Collapse
class UploadCreateResponse: …
upload: Upload
id: str
author_id: str
created_at: str
file_name: str
kind: Literal["3d", "asset", "audio", 4 more]

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

One of the following:
"3d"
"asset"
"audio"
"avatar"
"image"
"model"
"video"
owner_id: str
source: Literal["civitai", "huggingface", "multipart", 2 more]
One of the following:
"civitai"
"huggingface"
"multipart"
"other"
"url"
status: Literal["complete", "failed", "imported", 3 more]
One of the following:
"complete"
"failed"
"imported"
"pending"
"validated"
"validating"
updated_at: str
asset_options: Optional[UploadAssetOptions]
collection_ids: Optional[List[str]]

The collection ids to add the asset to.

hide: Optional[bool]

Specify if the asset should be hidden from the user.

parent_id: Optional[str]

The parentId of the asset.

config: Optional[object]
content_type: Optional[str]
entity_id: Optional[str]
error_message: Optional[str]
file_size: Optional[float]
job_id: Optional[str]
original_file_name: Optional[str]
parts: Optional[List[UploadPart]]
expires: str
number: float
url: str
parts_count: Optional[float]
provider: Optional[Literal["civitai", "huggingface", "other"]]
One of the following:
"civitai"
"huggingface"
"other"
url: Optional[str]
class UploadRetrieveResponse: …
upload: Upload
id: str
author_id: str
created_at: str
file_name: str
kind: Literal["3d", "asset", "audio", 4 more]

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

One of the following:
"3d"
"asset"
"audio"
"avatar"
"image"
"model"
"video"
owner_id: str
source: Literal["civitai", "huggingface", "multipart", 2 more]
One of the following:
"civitai"
"huggingface"
"multipart"
"other"
"url"
status: Literal["complete", "failed", "imported", 3 more]
One of the following:
"complete"
"failed"
"imported"
"pending"
"validated"
"validating"
updated_at: str
asset_options: Optional[UploadAssetOptions]
collection_ids: Optional[List[str]]

The collection ids to add the asset to.

hide: Optional[bool]

Specify if the asset should be hidden from the user.

parent_id: Optional[str]

The parentId of the asset.

config: Optional[object]
content_type: Optional[str]
entity_id: Optional[str]
error_message: Optional[str]
file_size: Optional[float]
job_id: Optional[str]
original_file_name: Optional[str]
parts: Optional[List[UploadPart]]
expires: str
number: float
url: str
parts_count: Optional[float]
provider: Optional[Literal["civitai", "huggingface", "other"]]
One of the following:
"civitai"
"huggingface"
"other"
url: Optional[str]
class UploadTriggerActionResponse: …
upload: Upload
id: str
author_id: str
created_at: str
file_name: str
kind: Literal["3d", "asset", "audio", 4 more]

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

One of the following:
"3d"
"asset"
"audio"
"avatar"
"image"
"model"
"video"
owner_id: str
source: Literal["civitai", "huggingface", "multipart", 2 more]
One of the following:
"civitai"
"huggingface"
"multipart"
"other"
"url"
status: Literal["complete", "failed", "imported", 3 more]
One of the following:
"complete"
"failed"
"imported"
"pending"
"validated"
"validating"
updated_at: str
asset_options: Optional[UploadAssetOptions]
collection_ids: Optional[List[str]]

The collection ids to add the asset to.

hide: Optional[bool]

Specify if the asset should be hidden from the user.

parent_id: Optional[str]

The parentId of the asset.

config: Optional[object]
content_type: Optional[str]
entity_id: Optional[str]
error_message: Optional[str]
file_size: Optional[float]
job_id: Optional[str]
original_file_name: Optional[str]
parts: Optional[List[UploadPart]]
expires: str
number: float
url: str
parts_count: Optional[float]
provider: Optional[Literal["civitai", "huggingface", "other"]]
One of the following:
"civitai"
"huggingface"
"other"
url: Optional[str]