API Reference

Uploads

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Trigger Action

POST/uploads/{uploadId}/action

Trigger an action on upload

Path ParametersExpand Collapse

uploadId: string

Body ParametersJSONExpand Collapse

action: "complete"

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

ReturnsExpand Collapse

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

Trigger Action

HTTP

HTTP

TypeScript

Python

curl https://api.cloud.scenario.com/v1/uploads/$UPLOAD_ID/action \
    -H 'Content-Type: application/json' \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET" \
    -d '{
          "action": "complete"
        }'

200 example

{
  "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

200 example

{
  "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"
  }
}