Skip to main content

Model List

Overview

This API retrieves a list of models with detailed information. The request requires an API key for authentication.

Example​

  • Method: GET

Endpoint​

 https://api.gpulab.ai/models

Request Headers​

KeyTypeDescription
api-keyStringYour authentication key.

Request Body​

There is no request body required for this endpoint.

Response​

Status Code: 200 OK

Response Body:

[
  {
    "image_name": "example_image_name",
    "min_vram": 4,
    "is_liked": true,
    "thumbnail": "https://example.com/thumbnail.jpg",
    "volume_disk": 50,
    "description": "Example model description",
    "volume_mount_path": "/mnt/models",
    "credentials_id": "cred_12345",
    "exposed_ports": [8080, 443],
    "container_disk": 20,
    "id": "model_001",
    "name": "Example Model",
    "author_url": "https://example.com/author",
    "environment_variables": {
      "VAR1": "value1",
      "VAR2": "value2"
    },
    "docker_image_url": "https://example.com/docker_image",
    "readme": "Model readme content.",
    "category_id": "category_001",
    "docker_command": "docker run --name example_model",
    "notes": "Model specific notes.",
    "visibility": "public",
    "is_bookmarked": false,
    "updated_date": "2024-11-20T00:00:00",
    "pull_status": "completed",
    "credentials": {
      "username": "user_example",
      "password": "password_example"
    }
  },
  {
    "image_name": "another_image_name",
    "min_vram": 8,
    "is_liked": false,
    "thumbnail": "https://example.com/another_thumbnail.jpg",
    "volume_disk": 100,
    "description": "Another model description",
    "volume_mount_path": "/mnt/another_model",
    "credentials_id": "cred_67890",
    "exposed_ports": [9090],
    "container_disk": 30,
    "id": "model_002",
    "name": "Another Model",
    "author_url": "https://example.com/another_author",
    "environment_variables": {
      "VAR1": "value3",
      "VAR2": "value4"
    },
    "docker_image_url": "https://example.com/another_docker_image",
    "readme": "Another model readme content.",
    "category_id": "category_002",
    "docker_command": "docker run --name another_model",
    "notes": "Another model specific notes.",
    "visibility": "private",
    "is_bookmarked": true,
    "updated_date": "2024-11-18T00:00:00",
    "pull_status": "in-progress",
    "credentials": {
      "username": "another_user",
      "password": "another_password"
    }
  }
]