API Reference

Libraries

TypeScript

0.0.1

npm install @scenario-labs/sdk

Read Docs

Python

0.0.1

pip install scenario-sdk

Read Docs

API Overview

Assets

Delete Multiple

DELETE/assets

Duplicate

POST/assets/{assetId}/copy

Get Bulk

POST/assets/get-bulk

List

GET/assets

List Snapshots

GET/assets/{assetId}/snapshots

Lock

PUT/assets/{assetId}/lock

Retrieve

GET/assets/{assetId}

Unlock

PUT/assets/{assetId}/unlock

Update

PUT/assets/{assetId}

Update Tags

PUT/assets/{assetId}/tags

Upload

POST/assets

AssetsDownload

Get Status

GET/assets/download/{jobId}

Request

POST/assets/{assetId}/download

Request Batch

POST/assets/download

Collections

Create

POST/collections

Delete

DELETE/collections/{collectionId}

List

GET/collections

Retrieve

GET/collections/{collectionId}

Update

PUT/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

Describe Style

POST/generate/describe-style

Detect

POST/generate/detect

Embed

POST/generate/embed

IP Detection

POST/generate/ip-detection

Patch

POST/generate/patch

Prompt

POST/generate/prompt

Quality Gate

POST/generate/quality-gate

Run Model

POST/generate/custom/{modelId}

Translate

POST/generate/translate

Jobs

List

GET/jobs

Retrieve

GET/jobs/{jobId}

Trigger Action

POST/jobs/{jobId}/action

Models

Copy

POST/models/{modelId}/copy

Create

POST/models

Delete

DELETE/models/{modelId}

Delete Images

DELETE/models/{modelId}/images

Download

POST/models/{modelId}/download

Get Bulk

POST/models/get-bulk

List

GET/models

Retrieve

GET/models/{modelId}

Transfer

POST/models/{modelId}/transfer

Update

PUT/models/{modelId}

Update Tags

PUT/models/{modelId}/tags

ModelsDescription

Retrieve

GET/models/{modelId}/description

Update

PUT/models/{modelId}/description

ModelsExamples

List

GET/models/{modelId}/examples

Update

PUT/models/{modelId}/examples

ModelsPresets

Create

POST/models/{modelId}/presets

Delete

DELETE/models/{modelId}/presets/{presetId}

List

GET/models/{modelId}/presets

Update

PUT/models/{modelId}/presets/{presetId}

ModelsPrompt Guide

Retrieve

GET/models/{modelId}/prompt-guide

Update

PUT/models/{modelId}/prompt-guide

ModelsScores

Retrieve Prompt

GET/models/{modelId}/scores/prompt

Retrieve Training Dataset

GET/models/{modelId}/scores/training-dataset

ModelsTrain

Action

POST/models/{modelId}/train/action

Trigger

PUT/models/{modelId}/train

ModelsTraining Images

Add

POST/models/{modelId}/training-images

Delete

DELETE/models/{modelId}/training-images/{trainingImageId}

Replace

PUT/models/{modelId}/training-images/{trainingImageId}

Replace Pairs

PUT/models/{modelId}/training-images/pairs

Oscu

Retrieve Prices

Deprecated

GET/oscu/prices

Pricing

PricingOscu

Retrieve Prices

GET/oscu/prices

Projects

Create

POST/projects

Delete

DELETE/projects/{projectId}

List

GET/projects

Retrieve

GET/projects/{projectId}

Update

PUT/projects/{projectId}

ProjectsAPI Keys

Create

POST/projects/{projectId}/api-keys

Delete

DELETE/projects/{projectId}/api-keys/{keyId}

ProjectsBrief

Delete

DELETE/projects/{projectId}/brief

Retrieve

GET/projects/{projectId}/brief

Update

PUT/projects/{projectId}/brief

ProjectsInstructions

Retrieve

GET/projects/{projectId}/instructions

Update

PUT/projects/{projectId}/instructions

ProjectsMembers

Create

POST/projects/{projectId}/members

Delete

DELETE/projects/{projectId}/members/{memberId}

Update

PUT/projects/{projectId}/members/{memberId}

ProjectsMemory

Retrieve

GET/projects/{projectId}/memory

Update

PUT/projects/{projectId}/memory

ProjectsWatermark

Delete

DELETE/projects/{projectId}/watermark

Delete Logo

DELETE/projects/{projectId}/watermark/logo

Preview

POST/projects/{projectId}/watermark/preview

Retrieve

GET/projects/{projectId}/watermark

Update

PUT/projects/{projectId}/watermark

Update Logo

PUT/projects/{projectId}/watermark/logo

ProjectsWebhook Endpoints

Create

POST/projects/{projectId}/webhook-endpoints

Delete

DELETE/projects/{projectId}/webhook-endpoints/{webhookEndpointId}

List

GET/projects/{projectId}/webhook-endpoints

Update

PUT/projects/{projectId}/webhook-endpoints/{webhookEndpointId}

ProjectsWebhook EndpointsEvents

List

GET/projects/{projectId}/webhook-endpoints/{webhookEndpointId}/events

Retrieve

GET/projects/{projectId}/webhook-endpoints/{webhookEndpointId}/events/{eventId}

Recommendations

List Models

GET/recommendations/models

Search

Asset Search

POST/search/assets

Model Search

POST/search/models

Workflow Search

POST/search/workflows

Tags

List

GET/tags

Teams

Delete Invitations

DELETE/teams/{teamId}/invitations

List

GET/teams

Retrieve

GET/teams/{teamId}

Retrieve Limits

GET/teams/{teamId}/limits

Update

PUT/teams/{teamId}

TeamsBrief

Delete

DELETE/teams/{teamId}/brief

Retrieve

GET/teams/{teamId}/brief

Update

PUT/teams/{teamId}/brief

TeamsIP Filters

Create

POST/teams/{teamId}/ip-filters

Delete

DELETE/teams/{teamId}/ip-filters/{filterId}

Draft Instruction

POST/teams/{teamId}/ip-filters/draft-instruction

List

GET/teams/{teamId}/ip-filters

Update

PUT/teams/{teamId}/ip-filters/{filterId}

TeamsMembers

Create

POST/teams/{teamId}/members

Delete

DELETE/teams/{teamId}/members/{memberId}

Update

PUT/teams/{teamId}/members/{memberId}

TeamsWatermark

Delete

DELETE/teams/{teamId}/watermark

Delete Logo

DELETE/teams/{teamId}/watermark/logo

Preview

POST/teams/{teamId}/watermark/preview

Retrieve

GET/teams/{teamId}/watermark

Update

PUT/teams/{teamId}/watermark

Update Logo

PUT/teams/{teamId}/watermark/logo

TeamsWebhook Endpoints

Create

POST/teams/{teamId}/webhook-endpoints

Delete

DELETE/teams/{teamId}/webhook-endpoints/{webhookEndpointId}

List

GET/teams/{teamId}/webhook-endpoints

Update

PUT/teams/{teamId}/webhook-endpoints/{webhookEndpointId}

TeamsWebhook EndpointsEvents

List

GET/teams/{teamId}/webhook-endpoints/{webhookEndpointId}/events

Retrieve

GET/teams/{teamId}/webhook-endpoints/{webhookEndpointId}/events/{eventId}

Uploads

Create

POST/uploads

Retrieve

GET/uploads/{uploadId}

Trigger Action

POST/uploads/{uploadId}/action

Usages

List

GET/usages

Workflows

Approve User

Deprecated

PUT/workflows/{workflowId}/user-approval

Create

POST/workflows

Delete

DELETE/workflows/{workflowId}

Get Tags

GET/workflows/tags

List

GET/workflows

Retrieve

GET/workflows/{workflowId}

Run

PUT/workflows/{workflowId}/run

Update

PUT/workflows/{workflowId}

User Approval

PUT/workflows/{workflowId}/user-approval

User Selection

PUT/workflows/{workflowId}/user-selection