Skip to content
Scenario Docs
Get started
API Reference
Uploads

Trigger Action

uploads.trigger_action(strupload_id, UploadTriggerActionParams**kwargs) -> UploadTriggerActionResponse
POST/uploads/{uploadId}/action

Trigger an action on upload

ParametersExpand Collapse
upload_id: str
action: Literal["complete"]

The action to perform on an upload, currently only “upload-complete” is supported

ReturnsExpand Collapse
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]

Trigger Action

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
response = client.uploads.trigger_action(
    upload_id="uploadId",
    action="complete",
)
print(response.upload)
{
  "upload": {
    "id": "id",
    "authorId": "authorId",
    "createdAt": "createdAt",
    "fileName": "fileName",
    "kind": "3d",
    "ownerId": "ownerId",
    "source": "civitai",
    "status": "complete",
    "updatedAt": "updatedAt",
    "assetOptions": {
      "collectionIds": [
        "string"
      ],
      "hide": true,
      "parentId": "parentId"
    },
    "config": {},
    "contentType": "contentType",
    "entityId": "entityId",
    "errorMessage": "errorMessage",
    "fileSize": 0,
    "jobId": "jobId",
    "originalFileName": "originalFileName",
    "parts": [
      {
        "expires": "expires",
        "number": 0,
        "url": "url"
      }
    ],
    "partsCount": 0,
    "provider": "civitai",
    "url": "url"
  }
}
Returns Examples
{
  "upload": {
    "id": "id",
    "authorId": "authorId",
    "createdAt": "createdAt",
    "fileName": "fileName",
    "kind": "3d",
    "ownerId": "ownerId",
    "source": "civitai",
    "status": "complete",
    "updatedAt": "updatedAt",
    "assetOptions": {
      "collectionIds": [
        "string"
      ],
      "hide": true,
      "parentId": "parentId"
    },
    "config": {},
    "contentType": "contentType",
    "entityId": "entityId",
    "errorMessage": "errorMessage",
    "fileSize": 0,
    "jobId": "jobId",
    "originalFileName": "originalFileName",
    "parts": [
      {
        "expires": "expires",
        "number": 0,
        "url": "url"
      }
    ],
    "partsCount": 0,
    "provider": "civitai",
    "url": "url"
  }
}