Skip to content
Scenario Docs
Get started
API Reference
Assets

List

GET/assets

List assets of a project team. Supports both public access (via the Authorization header set to public-auth-token) and authenticated user access (including API keys).

Query ParametersExpand Collapse
authorId: optional string

List assets generated by a specific author (the user that created the asset)

collectionId: optional unknown
createdAfter: optional string

Filter results to only return assets created after the specified ISO string date (exclusive). Requires the sortBy parameter to be “createdAt”

createdBefore: optional string

Filter results to only return assets created before the specified ISO string date (exclusive). Requires the sortBy parameter to be “createdAt”

inferenceId: optional string

List assets generated from a specific inference

modelId: optional string

List assets generated from all inferences coming from a specific model (this is not the training images)

originalAssets: optional boolean

If set to true, returns the original asset without transformation

pageSize: optional number

The number of items to return in the response. The default value is 50, maximum value is 100, minimum value is 1

minimum1
maximum100
paginationToken: optional string

A token you received in a previous request to query the next page of items

parentAssetId: optional string

List all the children assets that were generated from a specific parent asset

privacy: optional string

Filters result by asset privacy. If set to public, it will return -all- public assets from all organizations

rootAssetId: optional string

List all the children assets that were generated from a specific root asset

sortBy: optional string

Sort results by the createdAt or updatedAt

sortDirection: optional string

Sort results in ascending (asc) or descending (desc) order

tags: optional string

List of tags, comma separated. Only for public assets on all teams.

type: optional "inference-txt2img" or "inference-txt2img-ip-adapter" or "inference-txt2img-texture" or 72 more

List all the assets of a specific type. The parameter “type” and “types” cannot be used together. Can be any of the following values: inference-txt2img, inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img, inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint, inference-inpaint-ip-adapter, inference-reference, inference-reference-texture, inference-controlnet, inference-controlnet-ip-adapter, inference-controlnet-img2img, inference-controlnet-reference, inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter, inference-controlnet-texture, background-removal, canvas, canvas-export, canvas-drawing, detection, patch, pixelization, upscale, upscale-texture, upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask, skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill, texture, texture-height, texture-normal, texture-smoothness, texture-metallic, texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d, txt23d, video23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl, 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic, img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone, video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video, uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video, assets with a type starting with “inference-” will be returned

One of the following:
"inference-txt2img"
"inference-txt2img-ip-adapter"
"inference-txt2img-texture"
"inference-img2img"
"inference-img2img-ip-adapter"
"inference-img2img-texture"
"inference-inpaint"
"inference-inpaint-ip-adapter"
"inference-reference"
"inference-reference-texture"
"inference-controlnet"
"inference-controlnet-ip-adapter"
"inference-controlnet-img2img"
"inference-controlnet-reference"
"inference-controlnet-inpaint"
"inference-controlnet-inpaint-ip-adapter"
"inference-controlnet-texture"
"background-removal"
"canvas"
"canvas-export"
"canvas-drawing"
"detection"
"patch"
"pixelization"
"upscale"
"upscale-texture"
"upscale-skybox"
"vectorization"
"segment"
"segmentation-image"
"segmentation-mask"
"skybox-base-360"
"skybox-hdri"
"skybox-3d"
"restyle"
"reframe"
"generative-fill"
"texture"
"texture-height"
"texture-normal"
"texture-smoothness"
"texture-metallic"
"texture-edge"
"texture-ao"
"texture-albedo"
"image-prompt-editing"
"unknown"
"img23d"
"txt23d"
"video23d"
"3d23d"
"3d23d-texture"
"3d-texture"
"3d-texture-mtl"
"3d-texture-albedo"
"3d-texture-normal"
"3d-texture-roughness"
"3d-texture-metallic"
"img2video"
"txt2audio"
"audio2audio"
"audio2video"
"video2audio"
"voice-clone"
"video2video"
"video2img"
"txt2img"
"img2img"
"txt2video"
"uploaded"
"uploaded-video"
"uploaded-audio"
"uploaded-3d"
"uploaded-avatar"
"upscale-video"
types: optional array of "inference-txt2img" or "inference-txt2img-ip-adapter" or "inference-txt2img-texture" or 72 more

List of the asset types to request. The parameter “type” and “types” cannot be used together. Can be any of the following values: inference-txt2img, inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img, inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint, inference-inpaint-ip-adapter, inference-reference, inference-reference-texture, inference-controlnet, inference-controlnet-ip-adapter, inference-controlnet-img2img, inference-controlnet-reference, inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter, inference-controlnet-texture, background-removal, canvas, canvas-export, canvas-drawing, detection, patch, pixelization, upscale, upscale-texture, upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask, skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill, texture, texture-height, texture-normal, texture-smoothness, texture-metallic, texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d, txt23d, video23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl, 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic, img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone, video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video, uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video

One of the following:
"inference-txt2img"
"inference-txt2img-ip-adapter"
"inference-txt2img-texture"
"inference-img2img"
"inference-img2img-ip-adapter"
"inference-img2img-texture"
"inference-inpaint"
"inference-inpaint-ip-adapter"
"inference-reference"
"inference-reference-texture"
"inference-controlnet"
"inference-controlnet-ip-adapter"
"inference-controlnet-img2img"
"inference-controlnet-reference"
"inference-controlnet-inpaint"
"inference-controlnet-inpaint-ip-adapter"
"inference-controlnet-texture"
"background-removal"
"canvas"
"canvas-export"
"canvas-drawing"
"detection"
"patch"
"pixelization"
"upscale"
"upscale-texture"
"upscale-skybox"
"vectorization"
"segment"
"segmentation-image"
"segmentation-mask"
"skybox-base-360"
"skybox-hdri"
"skybox-3d"
"restyle"
"reframe"
"generative-fill"
"texture"
"texture-height"
"texture-normal"
"texture-smoothness"
"texture-metallic"
"texture-edge"
"texture-ao"
"texture-albedo"
"image-prompt-editing"
"unknown"
"img23d"
"txt23d"
"video23d"
"3d23d"
"3d23d-texture"
"3d-texture"
"3d-texture-mtl"
"3d-texture-albedo"
"3d-texture-normal"
"3d-texture-roughness"
"3d-texture-metallic"
"img2video"
"txt2audio"
"audio2audio"
"audio2video"
"video2audio"
"voice-clone"
"video2video"
"video2img"
"txt2img"
"img2img"
"txt2video"
"uploaded"
"uploaded-video"
"uploaded-audio"
"uploaded-3d"
"uploaded-avatar"
"upscale-video"
updatedAfter: optional string

Filter results to only return assets updated after the specified ISO string date (exclusive). Requires the sortBy parameter to be “updatedAt”

updatedBefore: optional string

Filter results to only return assets updated before the specified ISO string date (exclusive). Requires the sortBy parameter to be “updatedAt”

ReturnsExpand Collapse
assets: array of object { id, authorId, collectionIds, 24 more }
id: string

The asset ID (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

authorId: string

The author user ID (example: “dcf121faaa1a0a0bbbd9ca1b73d62aea”)

collectionIds: array of string

A list of CollectionId this asset belongs to

createdAt: string

The asset creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

editCapabilities: array of "DETECTION" or "GENERATIVE_FILL" or "PIXELATE" or 8 more

List of edit capabilities

One of the following:
"DETECTION"
"GENERATIVE_FILL"
"PIXELATE"
"PROMPT_EDITING"
"REFINE"
"REFRAME"
"REMOVE_BACKGROUND"
"SEGMENTATION"
"UPSCALE"
"UPSCALE_360"
"VECTORIZATION"
kind: "3d" or "audio" or "document" or 4 more

The kind of asset

One of the following:
"3d"
"audio"
"document"
"image"
"image-hdr"
"json"
"video"
metadata: object { kind, type, angular, 106 more }

Metadata of the asset with some additional information

kind: "3d" or "audio" or "document" or 4 more
One of the following:
"3d"
"audio"
"document"
"image"
"image-hdr"
"json"
"video"
type: "3d-texture" or "3d-texture-albedo" or "3d-texture-metallic" or 72 more

The type of the asset. Ex: ‘inference-txt2img’ will represent an asset generated from a text to image model

One of the following:
"3d-texture"
"3d-texture-albedo"
"3d-texture-metallic"
"3d-texture-mtl"
"3d-texture-normal"
"3d-texture-roughness"
"3d23d"
"3d23d-texture"
"audio2audio"
"audio2video"
"background-removal"
"canvas"
"canvas-drawing"
"canvas-export"
"detection"
"generative-fill"
"image-prompt-editing"
"img23d"
"img2img"
"img2video"
"inference-controlnet"
"inference-controlnet-img2img"
"inference-controlnet-inpaint"
"inference-controlnet-inpaint-ip-adapter"
"inference-controlnet-ip-adapter"
"inference-controlnet-reference"
"inference-controlnet-texture"
"inference-img2img"
"inference-img2img-ip-adapter"
"inference-img2img-texture"
"inference-inpaint"
"inference-inpaint-ip-adapter"
"inference-reference"
"inference-reference-texture"
"inference-txt2img"
"inference-txt2img-ip-adapter"
"inference-txt2img-texture"
"patch"
"pixelization"
"reframe"
"restyle"
"segment"
"segmentation-image"
"segmentation-mask"
"skybox-3d"
"skybox-base-360"
"skybox-hdri"
"texture"
"texture-albedo"
"texture-ao"
"texture-edge"
"texture-height"
"texture-metallic"
"texture-normal"
"texture-smoothness"
"txt23d"
"txt2audio"
"txt2img"
"txt2video"
"unknown"
"uploaded"
"uploaded-3d"
"uploaded-audio"
"uploaded-avatar"
"uploaded-video"
"upscale"
"upscale-skybox"
"upscale-texture"
"upscale-video"
"vectorization"
"video23d"
"video2audio"
"video2img"
"video2video"
"voice-clone"
angular: optional number

How angular is the surface? 0 is like a sphere, 1 is like a mechanical object

maximum1
minimum0
aspectRatio: optional string

The optional aspect ratio given for the generation, only applicable for some models

backgroundOpacity: optional number

Int to set between 0 and 255 for the opacity of the background in the result images.

maximum255
minimum0
baseModelId: optional string

The baseModelId that maybe changed at inference time

bbox: optional array of number

A bounding box around the object of interest, in the format [x1, y1, x2, y2].

betterQuality: optional boolean

Remove small dark spots (i.e. “pepper”) and connect small bright cracks.

cannyStructureImage: optional string

The control image already processed by canny detector. Must reference an existing AssetId.

clustering: optional boolean

Activate clustering.

colorCorrection: optional boolean

Ensure upscaled tile have the same color histogram as original tile.

colorMode: optional string
colorPrecision: optional number
concepts: optional array of object { modelId, scale, modelEpoch }

Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.

modelId: string

The model ID (example: “model_eyVcnFJcR92BxBkz7N6g5w”)

scale: number

The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale is between 0 and 2.

maximum2
minimum-2
modelEpoch: optional string

The epoch of the model (example: “000001”) Only available for Flux Lora Trained models

contours: optional array of array of array of array of number
controlEnd: optional number

End step for control.

copiedAt: optional string

The date when the asset was copied to a project

cornerThreshold: optional number
creativity: optional number

Allow the generation of “hallucinations” during the upscale process, which adds additional details and deviates from the original image. Default: optimized for your preset and style.

maximum100
minimum0
creativityDecay: optional number

Amount of decay in creativity over the upscale process. The lowest the value, the less the creativity will be preserved over the upscale process.

maximum100
minimum0
defaultParameters: optional boolean

If true, use the default parameters

depthFidelity: optional number

The depth fidelity if a depth image provided

maximum100
minimum0
depthImage: optional string

The control image processed by depth estimator. Must reference an existing AssetId.

detailsLevel: optional number

Amount of details to remove or add

maximum50
minimum-50
dilate: optional number

The number of pixels to dilate the result masks.

maximum30
minimum0
factor: optional number

Contrast factor for Grayscale detector

filterSpeckle: optional number
fractality: optional number

Determine the scale at which the upscale process works.

  • With a small value, the upscale works at the largest scale, resulting in fewer added details and more coherent images. Ideal for portraits, for example.
  • With a large value, the upscale works at the smallest scale, resulting in more added details and more hallucinations. Ideal for landscapes, for example.

(info): A small value is slower and more expensive to run.

maximum100
minimum0
geometryEnforcement: optional number

Apply extra control to the Skybox 360 geometry. The higher the value, the more the 360 geometry will influence the generated skybox image.

Use with caution. Default is adapted to the other parameters.

maximum100
minimum0
guidance: optional number

The guidance used to generate this asset

halfMode: optional boolean
hdr: optional number
height: optional number
highThreshold: optional number

High threshold for Canny detector

horizontalExpansionRatio: optional number

(deprecated) Horizontal expansion ratio.

maximum2
minimum1
image: optional string

The input image to process. Must reference an existing AssetId or be a data URL.

imageFidelity: optional number

Strengthen the similarity to the original image during the upscale. Default: optimized for your preset and style.

maximum100
minimum0
imageType: optional "seamfull" or "skybox" or "texture"

Preserve the seamless properties of skybox or texture images. Input has to be of same type (seamless).

One of the following:
"seamfull"
"skybox"
"texture"
inferenceId: optional string

The id of the Inference describing how this image was generated

inputFidelity: optional "high" or "low"

When set to high, allows to better preserve details from the input images in the output. This is especially useful when using images that contain elements like faces or logos that require accurate preservation in the generated image.

You can provide multiple input images that will all be preserved with high fidelity, but keep in mind that the first image will be preserved with richer textures and finer details, so if you include elements such as faces, consider placing them in the first image.

Only available for the gpt-image-1 model.

One of the following:
"high"
"low"
inputLocation: optional "bottom" or "left" or "middle" or 2 more

Location of the input image in the output.

One of the following:
"bottom"
"left"
"middle"
"right"
"top"
invert: optional boolean

To invert the relief

keypointThreshold: optional number

How polished is the surface? 0 is like a rough surface, 1 is like a mirror

maximum1
minimum0
layerDifference: optional number
lengthThreshold: optional number
lockExpiresAt: optional string

The ISO timestamp when the lock on the canvas will expire

lowThreshold: optional number

Low threshold for Canny detector

mask: optional string

The mask used for the asset generation or editing

maxIterations: optional number
maxThreshold: optional number

Maximum threshold for Grayscale conversion

minThreshold: optional number

Minimum threshold for Grayscale conversion

modality: optional "canny" or "depth" or "grayscale" or 7 more

Modality to detect

One of the following:
"canny"
"depth"
"grayscale"
"lineart_anime"
"mlsd"
"normal"
"pose"
"scribble"
"segmentation"
"sketch"
mode: optional string
modelId: optional string

The modelId used to generate this asset

modelType: optional "custom" or "elevenlabs-voice" or "flux.1" or 34 more

The type of the generator used

One of the following:
"custom"
"elevenlabs-voice"
"flux.1"
"flux.1-composition"
"flux.1-kontext-dev"
"flux.1-kontext-lora"
"flux.1-krea-dev"
"flux.1-krea-lora"
"flux.1-lora"
"flux.1-pro"
"flux.1.1-pro-ultra"
"flux.2-dev-edit-lora"
"flux.2-dev-lora"
"flux.2-klein-4b-edit-lora"
"flux.2-klein-4b-lora"
"flux.2-klein-9b-edit-lora"
"flux.2-klein-9b-lora"
"flux.2-klein-base-4b-edit-lora"
"flux.2-klein-base-4b-lora"
"flux.2-klein-base-9b-edit-lora"
"flux.2-klein-base-9b-lora"
"flux1.1-pro"
"gpt-image-1"
"qwen-image-2512-lora"
"qwen-image-edit-2509-lora"
"qwen-image-edit-2511-lora"
"qwen-image-edit-lora"
"qwen-image-lora"
"sd-1_5"
"sd-1_5-composition"
"sd-1_5-lora"
"sd-xl"
"sd-xl-composition"
"sd-xl-lora"
"zimage-de-turbo-lora"
"zimage-lora"
"zimage-turbo-lora"
name: optional string
nbMasks: optional number
negativePrompt: optional string

The negative prompt used to generate this asset

negativePromptStrength: optional number

Controls the influence of the negative prompt. Default 0 means the negative prompt has no effect. Higher values increase negative prompt influence. Must be > 0 if negativePrompt is provided.

maximum10
minimum0
numInferenceSteps: optional number

The number of denoising steps for each image generation.

maximum50
minimum5
numOutputs: optional number

The number of outputs to generate.

maximum8
minimum1
originalAssetId: optional string
outputIndex: optional number
overlapPercentage: optional number

Overlap percentage for the output image.

maximum0.5
minimum0
overrideEmbeddings: optional boolean

Override the embeddings of the model. Only your prompt and negativePrompt will be used. Use with caution.

parentId: optional string
parentJobId: optional string
pathPrecision: optional number
points: optional array of array of number

List of points (label, x, y) in the image where label = 0 for background and 1 for object.

polished: optional number

How polished is the surface? 0 is like a rough surface, 1 is like a mirror

maximum1
minimum0
preset: optional string
progressPercent: optional number
prompt: optional string

The prompt that guided the asset generation or editing

promptFidelity: optional number

Increase the fidelity to the prompt during upscale. Default: optimized for your preset and style.

maximum100
minimum0
raised: optional number

How raised is the surface? 0 is flat like water, 1 is like a very rough rock

maximum1
minimum0
referenceImages: optional array of string

The reference images used for the asset generation or editing

refinementSteps: optional number

Additional refinement steps before scaling.

If scalingFactor == 1, the refinement process will be applied (1 + refinementSteps) times. If scalingFactor > 1, the refinement process will be applied refinementSteps times.

maximum4
minimum0
removeBackground: optional boolean

Remove background for Grayscale detector

resizeOption: optional number

Size proportion of the input image in the output.

maximum1
minimum0.1
resultContours: optional boolean

Boolean to output the contours.

resultImage: optional boolean

Boolean to able output the cut out object.

resultMask: optional boolean

Boolean to able return the masks (binary image) in the response.

rootParentId: optional string
saveFlipbook: optional boolean

Save a flipbook of the texture. Deactivated when the input texture is larger than 2048x2048px

scalingFactor: optional number

Scaling factor (when targetWidth not specified)

maximum16
minimum1
scheduler: optional string

The scheduler used to generate this asset

seed: optional string

The seed used to generate this asset. <!> Can be a string or a number in some cases <!>.

sharpen: optional boolean

Sharpen tiles.

shiny: optional number

How shiny is the surface? 0 is like a matte surface, 1 is like a diamond

maximum1
minimum0
size: optional number
sketch: optional boolean

Activate sketch detection instead of canny.

sourceProjectId: optional string
spliceThreshold: optional number
strength: optional number

The strength

Only available for the flux-kontext LoRA model.

structureFidelity: optional number

Strength for the input image structure preservation

maximum100
minimum0
structureImage: optional string

The control image for structure. A canny detector will be applied to this image. Must reference an existing AssetId.

style: optional "3d-cartoon" or "3d-rendered" or "anime" or 23 more
One of the following:
"3d-cartoon"
"3d-rendered"
"anime"
"cartoon"
"cinematic"
"claymation"
"cloud-skydome"
"comic"
"cyberpunk"
"enchanted"
"fantasy"
"ink"
"manga"
"manga-color"
"minimalist"
"neon-tron"
"oil-painting"
"pastel"
"photo"
"photography"
"psychedelic"
"retro-fantasy"
"scifi-concept-art"
"space"
"standard"
"whimsical"
styleFidelity: optional number

The higher the value the more it will look like the style image(s)

maximum100
minimum0
styleImages: optional array of string

List of style images. Most of the time, only one image is enough. It must be existing AssetIds.

styleImagesFidelity: optional number

Condition the influence of the style image(s). The higher the value, the more the style images will influence the upscaled image.

maximum100
minimum0
targetHeight: optional number

The target height of the output image.

maximum2048
minimum0
targetWidth: optional number

Target width for the upscaled image, take priority over scaling factor

maximum16000
minimum1024
text: optional string

A textual description / keywords describing the object of interest.

maxLength100
texture: optional string

The asset to convert in texture maps. Must reference an existing AssetId.

thumbnail: optional object { assetId, url }

The thumbnail of the canvas

assetId: string

The AssetId of the image used as a thumbnail for the canvas (example: “asset_GTrL3mq4SXWyMxkOHRxlpw”)

url: string

The url of the image used as a thumbnail for the canvas

tileStyle: optional boolean

If set to true, during the upscaling process, the model will match tiles of the source image with tiles of the style image(s). This will result in a more coherent restyle. Works best with style images that have a similar composition.

trainingImage: optional boolean
verticalExpansionRatio: optional number

(deprecated) Vertical expansion ratio.

maximum2
minimum1
width: optional number

The width of the rendered image.

maximum2048
minimum1024
mimeType: string

The mime type of the asset (example: “image/png”)

ownerId: string

The owner (project) ID (example: “proj_23tlk332lkht3kl2” or “team_dlkhgs23tlk3hlkth32lkht3kl2” for old teams)

privacy: "private" or "public" or "unlisted"

The privacy of the asset

One of the following:
"private"
"public"
"unlisted"
properties: object { size, animationFrameCount, bitrate, 20 more }

The properties of the asset, content may depend on the kind of asset returned

size: number
animationFrameCount: optional number

Number of animation frames if animations exist

bitrate: optional number

Bitrate of the media in bits per second

boneCount: optional number

Number of bones if skeleton exists

channels: optional number

Number of channels of the audio

classification: optional "effect" or "interview" or "music" or 5 more

Classification of the audio

One of the following:
"effect"
"interview"
"music"
"other"
"sound"
"speech"
"text"
"unknown"
codecName: optional string

Codec name of the media

description: optional string

Description of the audio

dimensions: optional array of number

Bounding box dimensions [width, height, depth]

duration: optional number

Duration of the media in seconds

faceCount: optional number

Number of faces/triangles in the mesh

format: optional string

Format of the mesh file (e.g. ‘glb’, etc.)

frameRate: optional number

Frame rate of the video in frames per second

hasAnimations: optional boolean

Whether the mesh has animations

hasNormals: optional boolean

Whether the mesh has normal vectors

hasSkeleton: optional boolean

Whether the mesh has bones/skeleton

hasUVs: optional boolean

Whether the mesh has UV coordinates

height: optional number
nbFrames: optional number

Number of frames in the video

sampleRate: optional number

Sample rate of the media in Hz

transcription: optional object { text }

Transcription of the audio

text: string
vertexCount: optional number

Number of vertices in the mesh

width: optional number
source: "3d23d" or "3d23d:texture" or "3d:texture" or 72 more

source of the asset

One of the following:
"3d23d"
"3d23d:texture"
"3d:texture"
"3d:texture:albedo"
"3d:texture:metallic"
"3d:texture:mtl"
"3d:texture:normal"
"3d:texture:roughness"
"audio2audio"
"audio2video"
"background-removal"
"canvas"
"canvas-drawing"
"canvas-export"
"detection"
"generative-fill"
"image-prompt-editing"
"img23d"
"img2img"
"img2video"
"inference-control-net"
"inference-control-net-img"
"inference-control-net-inpainting"
"inference-control-net-inpainting-ip-adapter"
"inference-control-net-ip-adapter"
"inference-control-net-reference"
"inference-control-net-texture"
"inference-img"
"inference-img-ip-adapter"
"inference-img-texture"
"inference-in-paint"
"inference-in-paint-ip-adapter"
"inference-reference"
"inference-reference-texture"
"inference-txt"
"inference-txt-ip-adapter"
"inference-txt-texture"
"patch"
"pixelization"
"reframe"
"restyle"
"segment"
"segmentation-image"
"segmentation-mask"
"skybox-3d"
"skybox-base-360"
"skybox-hdri"
"texture"
"texture:albedo"
"texture:ao"
"texture:edge"
"texture:height"
"texture:metallic"
"texture:normal"
"texture:smoothness"
"txt23d"
"txt2audio"
"txt2img"
"txt2video"
"unknown"
"uploaded"
"uploaded-3d"
"uploaded-audio"
"uploaded-avatar"
"uploaded-video"
"upscale"
"upscale-skybox"
"upscale-texture"
"upscale-video"
"vectorization"
"video23d"
"video2audio"
"video2img"
"video2video"
"voice-clone"
status: "error" or "pending" or "success"

The actual status

One of the following:
"error"
"pending"
"success"
tags: array of string

The associated tags (example: [“sci-fi”, “landscape”])

updatedAt: string

The asset last update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

url: string

Signed URL to get the asset content

automaticCaptioning: optional string

Automatic captioning of the asset

description: optional string

The description, it will contain in priority:

  • the manual description
  • the advanced captioning when the asset is used in training flow
  • the automatic captioning
embedding: optional array of number

The embedding of the asset when requested.

Only available when an asset can be embedded (ie: not Detection maps)

firstFrame: optional object { assetId, url }

The video asset’s first frame.

Contains the assetId and the url of the first frame.

assetId: string
url: string
isHidden: optional boolean

Whether the asset is hidden.

lastFrame: optional object { assetId, url }

The video asset’s last frame.

Contains the assetId and the url of the last frame.

assetId: string
url: string
nsfw: optional array of string

The NSFW labels

originalFileUrl: optional string

The original file url.

Contains the url of the original file. without any conversion. Only available for some specific video, audio and threeD assets. Is only specified if the given asset data has been replaced with a new file during the creation of the asset.

outputIndex: optional number

The output index of the asset within a job This index is an positive integer that starts at 0 It is used to differentiate between multiple outputs of the same job If the job has only one output, this index is 0

preview: optional object { assetId, url }

The asset’s preview.

Contains the assetId and the url of the preview.

assetId: string
url: string
thumbnail: optional object { assetId, url }

The asset’s thumbnail.

Contains the assetId and the url of the thumbnail.

assetId: string
url: string
nextPaginationToken: optional string

A token to query the next page of assets

List

curl https://api.cloud.scenario.com/v1/assets \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET"
{
  "assets": [
    {
      "id": "id",
      "authorId": "authorId",
      "collectionIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "editCapabilities": [
        "DETECTION"
      ],
      "kind": "3d",
      "metadata": {
        "kind": "3d",
        "type": "3d-texture",
        "angular": 0,
        "aspectRatio": "aspectRatio",
        "backgroundOpacity": 0,
        "baseModelId": "baseModelId",
        "bbox": [
          0,
          0,
          0,
          0
        ],
        "betterQuality": true,
        "cannyStructureImage": "cannyStructureImage",
        "clustering": true,
        "colorCorrection": true,
        "colorMode": "colorMode",
        "colorPrecision": 0,
        "concepts": [
          {
            "modelId": "modelId",
            "scale": -2,
            "modelEpoch": "modelEpoch"
          }
        ],
        "contours": [
          [
            [
              [
                0
              ]
            ]
          ]
        ],
        "controlEnd": 0,
        "copiedAt": "copiedAt",
        "cornerThreshold": 0,
        "creativity": 0,
        "creativityDecay": 0,
        "defaultParameters": true,
        "depthFidelity": 0,
        "depthImage": "depthImage",
        "detailsLevel": -50,
        "dilate": 0,
        "factor": 0,
        "filterSpeckle": 0,
        "fractality": 0,
        "geometryEnforcement": 0,
        "guidance": 0,
        "halfMode": true,
        "hdr": 0,
        "height": 0,
        "highThreshold": 0,
        "horizontalExpansionRatio": 1,
        "image": "image",
        "imageFidelity": 0,
        "imageType": "seamfull",
        "inferenceId": "inferenceId",
        "inputFidelity": "high",
        "inputLocation": "bottom",
        "invert": true,
        "keypointThreshold": 0,
        "layerDifference": 0,
        "lengthThreshold": 0,
        "lockExpiresAt": "lockExpiresAt",
        "lowThreshold": 0,
        "mask": "mask",
        "maxIterations": 0,
        "maxThreshold": 0,
        "minThreshold": 0,
        "modality": "canny",
        "mode": "mode",
        "modelId": "modelId",
        "modelType": "custom",
        "name": "name",
        "nbMasks": 0,
        "negativePrompt": "negativePrompt",
        "negativePromptStrength": 0,
        "numInferenceSteps": 5,
        "numOutputs": 1,
        "originalAssetId": "originalAssetId",
        "outputIndex": 0,
        "overlapPercentage": 0,
        "overrideEmbeddings": true,
        "parentId": "parentId",
        "parentJobId": "parentJobId",
        "pathPrecision": 0,
        "points": [
          [
            0
          ],
          [
            0
          ],
          [
            0
          ]
        ],
        "polished": 0,
        "preset": "preset",
        "progressPercent": 0,
        "prompt": "prompt",
        "promptFidelity": 0,
        "raised": 0,
        "referenceImages": [
          "string"
        ],
        "refinementSteps": 0,
        "removeBackground": true,
        "resizeOption": 0.1,
        "resultContours": true,
        "resultImage": true,
        "resultMask": true,
        "rootParentId": "rootParentId",
        "saveFlipbook": true,
        "scalingFactor": 1,
        "scheduler": "scheduler",
        "seed": "seed",
        "sharpen": true,
        "shiny": 0,
        "size": 0,
        "sketch": true,
        "sourceProjectId": "sourceProjectId",
        "spliceThreshold": 0,
        "strength": 0,
        "structureFidelity": 0,
        "structureImage": "structureImage",
        "style": "3d-cartoon",
        "styleFidelity": 0,
        "styleImages": [
          "string"
        ],
        "styleImagesFidelity": 0,
        "targetHeight": 0,
        "targetWidth": 1024,
        "text": "text",
        "texture": "texture",
        "thumbnail": {
          "assetId": "assetId",
          "url": "url"
        },
        "tileStyle": true,
        "trainingImage": true,
        "verticalExpansionRatio": 1,
        "width": 1024
      },
      "mimeType": "mimeType",
      "ownerId": "ownerId",
      "privacy": "private",
      "properties": {
        "size": 0,
        "animationFrameCount": 0,
        "bitrate": 0,
        "boneCount": 0,
        "channels": 0,
        "classification": "effect",
        "codecName": "codecName",
        "description": "description",
        "dimensions": [
          0,
          0,
          0
        ],
        "duration": 0,
        "faceCount": 0,
        "format": "format",
        "frameRate": 0,
        "hasAnimations": true,
        "hasNormals": true,
        "hasSkeleton": true,
        "hasUVs": true,
        "height": 0,
        "nbFrames": 0,
        "sampleRate": 0,
        "transcription": {
          "text": "text"
        },
        "vertexCount": 0,
        "width": 0
      },
      "source": "3d23d",
      "status": "error",
      "tags": [
        "string"
      ],
      "updatedAt": "updatedAt",
      "url": "url",
      "automaticCaptioning": "automaticCaptioning",
      "description": "description",
      "embedding": [
        0
      ],
      "firstFrame": {
        "assetId": "assetId",
        "url": "url"
      },
      "isHidden": true,
      "lastFrame": {
        "assetId": "assetId",
        "url": "url"
      },
      "nsfw": [
        "string"
      ],
      "originalFileUrl": "originalFileUrl",
      "outputIndex": 0,
      "preview": {
        "assetId": "assetId",
        "url": "url"
      },
      "thumbnail": {
        "assetId": "assetId",
        "url": "url"
      }
    }
  ],
  "nextPaginationToken": "nextPaginationToken"
}
Returns Examples
{
  "assets": [
    {
      "id": "id",
      "authorId": "authorId",
      "collectionIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "editCapabilities": [
        "DETECTION"
      ],
      "kind": "3d",
      "metadata": {
        "kind": "3d",
        "type": "3d-texture",
        "angular": 0,
        "aspectRatio": "aspectRatio",
        "backgroundOpacity": 0,
        "baseModelId": "baseModelId",
        "bbox": [
          0,
          0,
          0,
          0
        ],
        "betterQuality": true,
        "cannyStructureImage": "cannyStructureImage",
        "clustering": true,
        "colorCorrection": true,
        "colorMode": "colorMode",
        "colorPrecision": 0,
        "concepts": [
          {
            "modelId": "modelId",
            "scale": -2,
            "modelEpoch": "modelEpoch"
          }
        ],
        "contours": [
          [
            [
              [
                0
              ]
            ]
          ]
        ],
        "controlEnd": 0,
        "copiedAt": "copiedAt",
        "cornerThreshold": 0,
        "creativity": 0,
        "creativityDecay": 0,
        "defaultParameters": true,
        "depthFidelity": 0,
        "depthImage": "depthImage",
        "detailsLevel": -50,
        "dilate": 0,
        "factor": 0,
        "filterSpeckle": 0,
        "fractality": 0,
        "geometryEnforcement": 0,
        "guidance": 0,
        "halfMode": true,
        "hdr": 0,
        "height": 0,
        "highThreshold": 0,
        "horizontalExpansionRatio": 1,
        "image": "image",
        "imageFidelity": 0,
        "imageType": "seamfull",
        "inferenceId": "inferenceId",
        "inputFidelity": "high",
        "inputLocation": "bottom",
        "invert": true,
        "keypointThreshold": 0,
        "layerDifference": 0,
        "lengthThreshold": 0,
        "lockExpiresAt": "lockExpiresAt",
        "lowThreshold": 0,
        "mask": "mask",
        "maxIterations": 0,
        "maxThreshold": 0,
        "minThreshold": 0,
        "modality": "canny",
        "mode": "mode",
        "modelId": "modelId",
        "modelType": "custom",
        "name": "name",
        "nbMasks": 0,
        "negativePrompt": "negativePrompt",
        "negativePromptStrength": 0,
        "numInferenceSteps": 5,
        "numOutputs": 1,
        "originalAssetId": "originalAssetId",
        "outputIndex": 0,
        "overlapPercentage": 0,
        "overrideEmbeddings": true,
        "parentId": "parentId",
        "parentJobId": "parentJobId",
        "pathPrecision": 0,
        "points": [
          [
            0
          ],
          [
            0
          ],
          [
            0
          ]
        ],
        "polished": 0,
        "preset": "preset",
        "progressPercent": 0,
        "prompt": "prompt",
        "promptFidelity": 0,
        "raised": 0,
        "referenceImages": [
          "string"
        ],
        "refinementSteps": 0,
        "removeBackground": true,
        "resizeOption": 0.1,
        "resultContours": true,
        "resultImage": true,
        "resultMask": true,
        "rootParentId": "rootParentId",
        "saveFlipbook": true,
        "scalingFactor": 1,
        "scheduler": "scheduler",
        "seed": "seed",
        "sharpen": true,
        "shiny": 0,
        "size": 0,
        "sketch": true,
        "sourceProjectId": "sourceProjectId",
        "spliceThreshold": 0,
        "strength": 0,
        "structureFidelity": 0,
        "structureImage": "structureImage",
        "style": "3d-cartoon",
        "styleFidelity": 0,
        "styleImages": [
          "string"
        ],
        "styleImagesFidelity": 0,
        "targetHeight": 0,
        "targetWidth": 1024,
        "text": "text",
        "texture": "texture",
        "thumbnail": {
          "assetId": "assetId",
          "url": "url"
        },
        "tileStyle": true,
        "trainingImage": true,
        "verticalExpansionRatio": 1,
        "width": 1024
      },
      "mimeType": "mimeType",
      "ownerId": "ownerId",
      "privacy": "private",
      "properties": {
        "size": 0,
        "animationFrameCount": 0,
        "bitrate": 0,
        "boneCount": 0,
        "channels": 0,
        "classification": "effect",
        "codecName": "codecName",
        "description": "description",
        "dimensions": [
          0,
          0,
          0
        ],
        "duration": 0,
        "faceCount": 0,
        "format": "format",
        "frameRate": 0,
        "hasAnimations": true,
        "hasNormals": true,
        "hasSkeleton": true,
        "hasUVs": true,
        "height": 0,
        "nbFrames": 0,
        "sampleRate": 0,
        "transcription": {
          "text": "text"
        },
        "vertexCount": 0,
        "width": 0
      },
      "source": "3d23d",
      "status": "error",
      "tags": [
        "string"
      ],
      "updatedAt": "updatedAt",
      "url": "url",
      "automaticCaptioning": "automaticCaptioning",
      "description": "description",
      "embedding": [
        0
      ],
      "firstFrame": {
        "assetId": "assetId",
        "url": "url"
      },
      "isHidden": true,
      "lastFrame": {
        "assetId": "assetId",
        "url": "url"
      },
      "nsfw": [
        "string"
      ],
      "originalFileUrl": "originalFileUrl",
      "outputIndex": 0,
      "preview": {
        "assetId": "assetId",
        "url": "url"
      },
      "thumbnail": {
        "assetId": "assetId",
        "url": "url"
      }
    }
  ],
  "nextPaginationToken": "nextPaginationToken"
}