Skip to content
Scenario Docs
Get started
Overview

API Reference

Libraries

TypeScript
1.2.0
npm install @scenario-labs/sdk
Read Docs
Python
0.2.0
pip install scenario-sdk
Read Docs

API Overview

Assets

List
GET/assets
Upload
POST/assets
Delete Multiple
DELETE/assets
Get Bulk
POST/assets/get-bulk
Retrieve
GET/assets/{assetId}
Update
PUT/assets/{assetId}
Duplicate
POST/assets/{assetId}/copy
Lock
PUT/assets/{assetId}/lock
List Snapshots
GET/assets/{assetId}/snapshots
Update Tags
PUT/assets/{assetId}/tags
Unlock
PUT/assets/{assetId}/unlock

AssetsDownload

Request Batch
POST/assets/download
Get Status
GET/assets/download/{jobId}
Request
POST/assets/{assetId}/download

Collections

List
GET/collections
Create
POST/collections
Retrieve
GET/collections/{collectionId}
Update
PUT/collections/{collectionId}
Delete
DELETE/collections/{collectionId}

CollectionsAssets

Add
PUT/collections/{collectionId}/assets
Remove
DELETE/collections/{collectionId}/assets

CollectionsModels

Add
PUT/collections/{collectionId}/models
Remove
DELETE/collections/{collectionId}/models

Generate

Caption
POST/generate/caption
Run Model
POST/generate/custom/{modelId}
Describe Style
POST/generate/describe-style
Detect
POST/generate/detect
Embed
POST/generate/embed
Patch
POST/generate/patch
Translate
POST/generate/translate
Prompt
POST/generate/prompt

Jobs

List
GET/jobs
Retrieve
GET/jobs/{jobId}
Trigger Action
POST/jobs/{jobId}/action

Models

List
GET/models
Create
POST/models
Get Bulk
POST/models/get-bulk
Retrieve
GET/models/{modelId}
Update
PUT/models/{modelId}
Delete
DELETE/models/{modelId}
Copy
POST/models/{modelId}/copy
Download
POST/models/{modelId}/download
Delete Images
DELETE/models/{modelId}/images
Update Tags
PUT/models/{modelId}/tags
Transfer
POST/models/{modelId}/transfer

ModelsDescription

Retrieve
GET/models/{modelId}/description
Update
PUT/models/{modelId}/description

ModelsExamples

List
GET/models/{modelId}/examples
Update
PUT/models/{modelId}/examples

ModelsTrain

Trigger
PUT/models/{modelId}/train
Action
POST/models/{modelId}/train/action

ModelsTraining Images

Add
POST/models/{modelId}/training-images
Replace Pairs
PUT/models/{modelId}/training-images/pairs
Replace
PUT/models/{modelId}/training-images/{trainingImageId}
Delete
DELETE/models/{modelId}/training-images/{trainingImageId}

Pricing

PricingOscu

Retrieve Prices
GET/oscu/prices

Oscu

Retrieve Prices
Deprecated
GET/oscu/prices
Asset Search
POST/search/assets
Model Search
POST/search/models

Tags

List
GET/tags

Uploads

Create
POST/uploads
Retrieve
GET/uploads/{uploadId}
Trigger Action
POST/uploads/{uploadId}/action

Usages

List
GET/usages

Workflows

List
GET/workflows
Create
POST/workflows
Get Tags
GET/workflows/tags
Retrieve
GET/workflows/{workflowId}
Update
PUT/workflows/{workflowId}
Delete
DELETE/workflows/{workflowId}
Run
PUT/workflows/{workflowId}/run
User Approval
PUT/workflows/{workflowId}/user-approval
Approve User
Deprecated
PUT/workflows/{workflowId}/user-approval