List all models. Supports both public access (via the Authorization header set to public-auth-token) and authenticated user access (including API keys).
Parameters
If set to true, returns the full list of models (including blacklisted models) (only available for team admins)
collection_id: Optional[str]
When provided, only the models in the Collection will be returned. Only available when privacy=private/unlisted (note: this is different from collectionIds which is only for privacy=public)
collection_ids: Optional[str]
List of collection ids, comma separated. Only available when privacy=public
created_after: Optional[str]
Filter results to only return models created after the specified ISO string date (exclusive). Requires the sortBy parameter to be “createdAt”. Available for both privacy=public and privacy=private/unlisted
created_before: Optional[str]
Filter results to only return models created before the specified ISO string date (exclusive). Requires the sortBy parameter to be “createdAt”. Available for both privacy=public and privacy=private/unlisted
page_size: Optional[int]
The number of items to return in the response. The default value is 100, maximum value is 500, minimum value is 1
minimum1
maximum500
pagination_token: Optional[str]
A token you received in a previous request to query the next page of items
List
import os
from scenario_sdk import Scenario
client = Scenario(
api_key=os.environ.get("SCENARIO_SDK_API_KEY"), # This is the default and can be omitted
api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"), # This is the default and can be omitted
)
page = client.models.list()
page = page.models[0]
print(page.id){
"models": [
{
"id": "id",
"capabilities": [
"3d23d"
],
"collectionIds": [
"string"
],
"createdAt": "createdAt",
"custom": true,
"exampleAssetIds": [
"string"
],
"privacy": "private",
"source": "civitai",
"status": "copying",
"tags": [
"string"
],
"trainingImagesNumber": 0,
"type": "custom",
"updatedAt": "updatedAt",
"accessRestrictions": 0,
"authorId": "authorId",
"class": {
"category": "category",
"conceptPrompt": "conceptPrompt",
"modelId": "modelId",
"name": "name",
"prompt": "prompt",
"slug": "slug",
"status": "published",
"thumbnails": [
"string"
]
},
"compliantModelIds": [
"string"
],
"concepts": [
{
"modelId": "modelId",
"scale": -2,
"modelEpoch": "modelEpoch"
}
],
"epoch": "epoch",
"epochs": [
{
"epoch": "epoch",
"assets": [
{
"assetId": "assetId",
"url": "url"
}
]
}
],
"inputs": [
{
"name": "name",
"type": "boolean",
"allowedValues": [
{}
],
"backgroundBehavior": "opaque",
"color": true,
"costImpact": true,
"default": {},
"description": "description",
"group": "group",
"hint": "hint",
"inputs": [
{
"foo": "bar"
}
],
"kind": "3d",
"label": "label",
"maskFrom": "maskFrom",
"max": 0,
"maxLength": 0,
"maxSize": 0,
"min": 0,
"minLength": 0,
"modelTypes": [
"custom"
],
"parent": true,
"placeholder": "placeholder",
"prompt": true,
"promptSpark": true,
"required": {
"always": true,
"conditionalValues": {},
"ifDefined": {},
"ifNotDefined": {}
},
"step": 1
}
],
"modelKeyword": "modelKeyword",
"name": "name",
"negativePromptEmbedding": "negativePromptEmbedding",
"ownerId": "ownerId",
"parameters": {
"age": "age",
"batchSize": 1,
"classPrompt": "classPrompt",
"cloneType": "cloneType",
"conceptPrompt": "conceptPrompt",
"gender": "gender",
"language": "language",
"learningRate": 1,
"learningRateTextEncoder": 0.0005,
"learningRateUnet": 1,
"lrScheduler": "constant",
"maxTrainSteps": 0,
"nbEpochs": 1,
"nbRepeats": 1,
"numTextTrainSteps": 0,
"numUNetTrainSteps": 0,
"optimizeFor": "likeness",
"priorLossWeight": 1,
"randomCrop": true,
"randomCropRatio": 0,
"randomCropScale": 0,
"rank": 2,
"removeBackgroundNoise": true,
"samplePrompts": [
"string"
],
"sampleSourceImages": [
"string"
],
"scaleLr": true,
"seed": 0,
"textEncoderTrainingRatio": 0,
"validationFrequency": 0,
"validationPrompt": "validationPrompt",
"voiceDescription": "voiceDescription",
"wandbKey": "wandbKey"
},
"parentModelId": "parentModelId",
"performanceStats": {
"variants": [
{
"capability": "capability",
"computedAt": "computedAt",
"variantKey": "variantKey",
"arenaScore": {
"arenaCategory": "arenaCategory",
"arenaModelName": "arenaModelName",
"fetchedAt": "fetchedAt",
"rank": 0,
"rating": 0,
"ratingLower": 0,
"ratingUpper": 0,
"votes": 0
},
"costPerAssetMaxCU": 0,
"costPerAssetMinCU": 0,
"costPerAssetP50CU": 0,
"inferenceLatencyP50Sec": 0,
"inferenceLatencyP75Sec": 0,
"resolution": "resolution",
"totalLatencyP50Sec": 0,
"totalLatencyP75Sec": 0
}
],
"default": "default"
},
"promptEmbedding": "promptEmbedding",
"shortDescription": "shortDescription",
"softDeletionOn": "softDeletionOn",
"thumbnail": {
"assetId": "assetId",
"url": "url"
},
"trainingImagePairs": [
{
"instruction": "instruction",
"sourceId": "sourceId",
"targetId": "targetId"
}
],
"trainingImages": [
{
"id": "id",
"automaticCaptioning": "automaticCaptioning",
"createdAt": "createdAt",
"description": "description",
"downloadUrl": "downloadUrl",
"name": "name"
}
],
"trainingProgress": {
"stage": "pending",
"updatedAt": 0,
"position": 0,
"progress": 0,
"remainingTimeMs": 0,
"startedAt": 0
},
"trainingStats": {
"endedAt": "endedAt",
"queueDuration": 0,
"startedAt": "startedAt",
"trainDuration": 0
},
"uiConfig": {
"inputProperties": {
"foo": {
"collapsed": true
}
},
"lorasComponent": {
"label": "label",
"modelInput": "modelInput",
"scaleInput": "scaleInput",
"modelIdInput": "modelIdInput"
},
"presets": [
{
"fields": [
"string"
],
"presets": {}
}
],
"resolutionComponent": {
"heightInput": "heightInput",
"label": "label",
"presets": [
{
"height": 0,
"label": "label",
"width": 0
}
],
"widthInput": "widthInput"
},
"selects": {
"foo": {}
},
"triggerGenerate": {
"label": "label",
"after": "after",
"position": "bottom"
}
},
"userId": "userId"
}
],
"nextPaginationToken": "nextPaginationToken"
}Returns Examples
{
"models": [
{
"id": "id",
"capabilities": [
"3d23d"
],
"collectionIds": [
"string"
],
"createdAt": "createdAt",
"custom": true,
"exampleAssetIds": [
"string"
],
"privacy": "private",
"source": "civitai",
"status": "copying",
"tags": [
"string"
],
"trainingImagesNumber": 0,
"type": "custom",
"updatedAt": "updatedAt",
"accessRestrictions": 0,
"authorId": "authorId",
"class": {
"category": "category",
"conceptPrompt": "conceptPrompt",
"modelId": "modelId",
"name": "name",
"prompt": "prompt",
"slug": "slug",
"status": "published",
"thumbnails": [
"string"
]
},
"compliantModelIds": [
"string"
],
"concepts": [
{
"modelId": "modelId",
"scale": -2,
"modelEpoch": "modelEpoch"
}
],
"epoch": "epoch",
"epochs": [
{
"epoch": "epoch",
"assets": [
{
"assetId": "assetId",
"url": "url"
}
]
}
],
"inputs": [
{
"name": "name",
"type": "boolean",
"allowedValues": [
{}
],
"backgroundBehavior": "opaque",
"color": true,
"costImpact": true,
"default": {},
"description": "description",
"group": "group",
"hint": "hint",
"inputs": [
{
"foo": "bar"
}
],
"kind": "3d",
"label": "label",
"maskFrom": "maskFrom",
"max": 0,
"maxLength": 0,
"maxSize": 0,
"min": 0,
"minLength": 0,
"modelTypes": [
"custom"
],
"parent": true,
"placeholder": "placeholder",
"prompt": true,
"promptSpark": true,
"required": {
"always": true,
"conditionalValues": {},
"ifDefined": {},
"ifNotDefined": {}
},
"step": 1
}
],
"modelKeyword": "modelKeyword",
"name": "name",
"negativePromptEmbedding": "negativePromptEmbedding",
"ownerId": "ownerId",
"parameters": {
"age": "age",
"batchSize": 1,
"classPrompt": "classPrompt",
"cloneType": "cloneType",
"conceptPrompt": "conceptPrompt",
"gender": "gender",
"language": "language",
"learningRate": 1,
"learningRateTextEncoder": 0.0005,
"learningRateUnet": 1,
"lrScheduler": "constant",
"maxTrainSteps": 0,
"nbEpochs": 1,
"nbRepeats": 1,
"numTextTrainSteps": 0,
"numUNetTrainSteps": 0,
"optimizeFor": "likeness",
"priorLossWeight": 1,
"randomCrop": true,
"randomCropRatio": 0,
"randomCropScale": 0,
"rank": 2,
"removeBackgroundNoise": true,
"samplePrompts": [
"string"
],
"sampleSourceImages": [
"string"
],
"scaleLr": true,
"seed": 0,
"textEncoderTrainingRatio": 0,
"validationFrequency": 0,
"validationPrompt": "validationPrompt",
"voiceDescription": "voiceDescription",
"wandbKey": "wandbKey"
},
"parentModelId": "parentModelId",
"performanceStats": {
"variants": [
{
"capability": "capability",
"computedAt": "computedAt",
"variantKey": "variantKey",
"arenaScore": {
"arenaCategory": "arenaCategory",
"arenaModelName": "arenaModelName",
"fetchedAt": "fetchedAt",
"rank": 0,
"rating": 0,
"ratingLower": 0,
"ratingUpper": 0,
"votes": 0
},
"costPerAssetMaxCU": 0,
"costPerAssetMinCU": 0,
"costPerAssetP50CU": 0,
"inferenceLatencyP50Sec": 0,
"inferenceLatencyP75Sec": 0,
"resolution": "resolution",
"totalLatencyP50Sec": 0,
"totalLatencyP75Sec": 0
}
],
"default": "default"
},
"promptEmbedding": "promptEmbedding",
"shortDescription": "shortDescription",
"softDeletionOn": "softDeletionOn",
"thumbnail": {
"assetId": "assetId",
"url": "url"
},
"trainingImagePairs": [
{
"instruction": "instruction",
"sourceId": "sourceId",
"targetId": "targetId"
}
],
"trainingImages": [
{
"id": "id",
"automaticCaptioning": "automaticCaptioning",
"createdAt": "createdAt",
"description": "description",
"downloadUrl": "downloadUrl",
"name": "name"
}
],
"trainingProgress": {
"stage": "pending",
"updatedAt": 0,
"position": 0,
"progress": 0,
"remainingTimeMs": 0,
"startedAt": 0
},
"trainingStats": {
"endedAt": "endedAt",
"queueDuration": 0,
"startedAt": "startedAt",
"trainDuration": 0
},
"uiConfig": {
"inputProperties": {
"foo": {
"collapsed": true
}
},
"lorasComponent": {
"label": "label",
"modelInput": "modelInput",
"scaleInput": "scaleInput",
"modelIdInput": "modelIdInput"
},
"presets": [
{
"fields": [
"string"
],
"presets": {}
}
],
"resolutionComponent": {
"heightInput": "heightInput",
"label": "label",
"presets": [
{
"height": 0,
"label": "label",
"width": 0
}
],
"widthInput": "widthInput"
},
"selects": {
"foo": {}
},
"triggerGenerate": {
"label": "label",
"after": "after",
"position": "bottom"
}
},
"userId": "userId"
}
],
"nextPaginationToken": "nextPaginationToken"
}