/models

get https://api.cloud.scenario.com/v1/models

List all models

Response

Response body

object

models

array of objects

required

models*

object

captionWords

array of strings

The training caption words of the model

captionWords

trainingImages

array of objects

The URLs of the first 3 training images of the model. To retrieve the full set of images, get it by modelId

trainingImages

object

createdAt

string

required

The training image upload date as an ISO string (example: "2023-02-03T11:19:41.579Z")

automaticCaptioning

string

required

Automatic captioning of the image

downloadUrl

string

required

The URL of the image

name

string

required

The original file name of the image (example: "my-training-image.jpg")

description

string

required

Description for the image

string

required

The training image ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")

exampleAssetIds

array of strings

required

List of all example asset IDs setup by the model owner

exampleAssetIds*

privacy

string

required

Defaults to private

The privacy of the model (default: private)

private public unlisted

softDeletionOn

string

The date when the model will be soft deleted (only for Free plan)

source

string

required

The source of the model

civitai huggingface other scenario

ownerId

string

The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")

type

string

required

The model type (example: sd-1_5)

flux.1 flux.1-composition flux.1-lora flux.1-pro flux.1.1-pro-ultra flux1.1-pro sd-1_5 sd-1_5-composition sd-1_5-lora sd-xl sd-xl-composition sd-xl-lora

createdAt

string

required

The model creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")

trainingStats

object

Additional information about the model's training

promptEmbedding

string

Fine-tune the model's inferences with prompt embedding

trainingProgress

object

Additional information about the training progress of the model

string

required

The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")

class

object

The class of the model

updatedAt

string

required

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

thumbnail

object

A thumbnail for your model

capabilities

array of strings

required

List of model capabilities (example: ["txt2img", "img2img", "txt2img_ip_adapter", ...])

capabilities*

parentModelId

string

The id of the parent model

trainingImagesNumber

number

required

The total number of training images

modelKeyword

string

The model keyword, this is a legacy parameter, please use conceptPrompt in parameters

authorId

string

The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")

userId

string

(Deprecated) The user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")

tags

array of strings

required

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

tags*

negativePromptEmbedding

string

Fine-tune the model's inferences with negative prompt embedding

concepts

array of objects

The concepts is required for the type model: composition

concepts

object

modelId

string

required

The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")

scale

number

required

-2 to 2

The scale of the model (example: 1.0)

collectionIds

array of strings

required

A list of CollectionId this model belongs to

collectionIds*

name

string

The model name (example: "Low-poly dwarf")

parameters

object

The parameters of the model

compliantModelIds

array of strings

List of base model IDs compliant with the model (example: ["flux.1-dev", "flux.1-schnell"])
This attribute is mainly used for Flux LoRA models

compliantModelIds

status

string

required

The model status

copying failed new trained training training-canceled

nextPaginationToken

string

A token to query the next page of models

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cloud.scenario.com/v1/models \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response