Managing & Filtering Models with the Scenario API

The GET /models endpoint is your gateway to accessing the vast library of AI models available on Scenario. Whether you need to retrieve your own custom-trained private models, access official Scenario platform models, or explore third-party creations, this endpoint offers flexible filtering capabilities through parameters.

Endpoint Overview

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

Method: GET

Authentication: Required (Basic Auth with API Key & Secret)

This endpoint returns a paginated list of models available to your account. By default, it returns models you have created (Private). To access other types of models, you must use specific filters or complementary endpoints.

1. Filtering by Privacy (Private vs. Public)

To distinguish between your own private models and the public models available on the platform, you can use the following approaches.

Private Models

To retrieve only your private models (models you have trained yourself), simply call the endpoint with authentication. This is the default behavior.

curl -X GET "https://api.cloud.scenario.com/v1/models" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -H "Accept: application/json"

Public Models

To retrieve Public Models (including Scenario's official models and community public models), you typically use the dedicated public path or a privacy filter depending on your specific integration level.

Endpoint: GET /models/public

curl -X GET "https://api.cloud.scenario.com/v1/models/public" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -H "Accept: application/json"

2. Filtering by Tags

The most powerful way to sort and find specific types of models is by using the tags query parameter. This allows you to programmatically distinguish between official platform models and third-party or community models.

You can filter by multiple tags, but for your specific use case, here are the two key tags you need:

You will need to use the public models route for this:

GET https://api.cloud.scenario.com/v1/models/public

Example A: Get Official Scenario Models

Use this request to display only the curated list of Scenario models (e.g., for a "Scenario Models" tab in your UI).

curl -X GET "https://api.cloud.scenario.com/v1/models/public?tags=sc:scenario" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -H "Accept: application/json"

Example B: Get Third-Party Models

Use this request to display models from the broader community or partners.

curl -X GET "https://api.cloud.scenario.com/v1/models/public?tags=sc:third-party" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -H "Accept: application/json"

Example C: Combining Filters

You can usually combine pagination with these filters to load lists efficiently.

curl -X GET "https://api.cloud.scenario.com/v1/models/public?tags=sc:scenario&limit=20&offset=0" \
  -H "Authorization: Basic <YOUR_BASE64_CREDENTIALS>" \
  -H "Accept: application/json"

Response Structure

The API will return a JSON object containing a list of models. Each model object includes the tags array, which you can use to verify the classification on the client side.

{
  "models": [
    {
      "id": "model_xyz123",
      "name": "Scenario SDXL Base",
      "type": "checkpoint",
      "privacy": "public",
      "tags": ["sc:scenario", "base-model", "realistic"],
      "thumbnailUrl": "..."
    },
    {
      "id": "model_abc987",
      "name": "Community Toon Style",
      "type": "lora",
      "privacy": "public",
      "tags": ["sc:third-party", "cartoon"],
      "thumbnailUrl": "..."
    }
  ],
  "nextPaginationToken": "..."
}

Documentation & Resources

For a complete list of endpoints, parameters, and SDKs, please visit our full developer documentation:

• Scenario API Documentation

• API Reference (Swagger/OpenAPI)