API Reference

Uploads

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve

client.uploads.retrieve(stringuploadID, RequestOptionsoptions?): UploadRetrieveResponse { upload }

GET/uploads/{uploadId}

Get the details of an existing upload

ParametersExpand Collapse

uploadID: string

ReturnsExpand Collapse

UploadRetrieveResponse { upload }

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

id: string

authorId: string

createdAt: string

fileName: string

kind: "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"

ownerId: string

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

One of the following:

"civitai"

"huggingface"

"multipart"

"other"

"url"

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

One of the following:

"complete"

"failed"

"imported"

"pending"

"validated"

"validating"

updatedAt: string

assetOptions?: AssetOptions { collectionIds, hide, parentId }

collectionIds?: Array<string>

The collection ids to add the asset to.

hide?: boolean

Specify if the asset should be hidden from the user.

parentId?: string

The parentId of the asset.

config?: unknown

contentType?: string

entityId?: string

errorMessage?: string

fileSize?: number

jobId?: string

originalFileName?: string

parts?: Array<Part>

expires: string

number: number

url: string

partsCount?: number

provider?: "civitai" | "huggingface" | "other"

One of the following:

"civitai"

"huggingface"

"other"

url?: string

Retrieve

TypeScript

HTTP

TypeScript

Python

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const upload = await client.uploads.retrieve('uploadId');

console.log(upload.upload);

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