Models

List Models

get

Get models according to query filters.

Args: model_filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The models according to query filters.

Authorizations

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

tagany ofOptional

stringOptional

or

nullOptional

tagsany ofOptional

string[]Optional

or

nullOptional

scope_userany ofOptional

string · uuidOptional

or

nullOptional

userany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

projectany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/models HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-05-12T00:41:51.736Z",
        "updated": "2025-05-12T00:41:51.736Z",
        "user": {
          "body": {
            "created": "2025-05-12T00:41:51.736Z",
            "updated": "2025-05-12T00:41:51.736Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2025-05-12T00:41:51.736Z",
              "updated": "2025-05-12T00:41:51.736Z",
              "user": {
                "body": {
                  "created": "2025-05-12T00:41:51.736Z",
                  "updated": "2025-05-12T00:41:51.736Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "email": "text",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "color": "grey",
              "exclusive": true,
              "tagged_count": 1
            },
            "metadata": {},
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-05-12T00:41:51.736Z",
            "updated": "2025-05-12T00:41:51.736Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "license": "text",
        "description": "text",
        "audience": "text",
        "use_cases": "text",
        "limitations": "text",
        "trade_offs": "text",
        "ethics": "text",
        "save_models_to_registry": true
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Update Model

put

Updates a model.

Args: model_id: Name of the stack. model_update: Stack to use for the update.

Returns: The updated model.

Authorizations

Path parameters

model_idstring · uuidRequired

Body

Update model for models.

nameany ofOptional

stringOptional

or

nullOptional

licenseany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

audienceany ofOptional

stringOptional

or

nullOptional

use_casesany ofOptional

stringOptional

or

nullOptional

limitationsany ofOptional

stringOptional

or

nullOptional

trade_offsany ofOptional

stringOptional

or

nullOptional

ethicsany ofOptional

stringOptional

or

nullOptional

add_tagsany ofOptional

string[]Optional

or

nullOptional

remove_tagsany ofOptional

string[]Optional

or

nullOptional

save_models_to_registryany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/models/{model_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "name": "text",
  "license": "text",
  "description": "text",
  "audience": "text",
  "use_cases": "text",
  "limitations": "text",
  "trade_offs": "text",
  "ethics": "text",
  "add_tags": [
    "text"
  ],
  "remove_tags": [
    "text"
  ],
  "save_models_to_registry": true
}

{
  "body": {
    "created": "2025-05-12T00:41:51.736Z",
    "updated": "2025-05-12T00:41:51.736Z",
    "user": {
      "body": {
        "created": "2025-05-12T00:41:51.736Z",
        "updated": "2025-05-12T00:41:51.736Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-05-12T00:41:51.736Z",
          "updated": "2025-05-12T00:41:51.736Z",
          "user": {
            "body": {
              "created": "2025-05-12T00:41:51.736Z",
              "updated": "2025-05-12T00:41:51.736Z",
              "active": true,
              "activation_token": "text",
              "full_name": "text",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "metadata": {
              "email": "text",
              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
              "user_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          },
          "color": "grey",
          "exclusive": true,
          "tagged_count": 1
        },
        "metadata": {},
        "resources": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": true,
        "name": "text"
      }
    ],
    "latest_version_name": "text",
    "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-05-12T00:41:51.736Z",
        "updated": "2025-05-12T00:41:51.736Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "license": "text",
    "description": "text",
    "audience": "text",
    "use_cases": "text",
    "limitations": "text",
    "trade_offs": "text",
    "ethics": "text",
    "save_models_to_registry": true
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}