Show Model List

Retrieves a list of existing models.

Endpoint

GET /api/models

Parameters

Parameter
Type
Required
Description

name

string

No

Search term to filter models by name.

page

integer

No

Page number for pagination.

page_size

integer

No

Page size for pagination.

Request Example

curl -X GET "https://api.deepmode.ai/api/models?name=model" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_SECRET_API_KEY"

Response

Upon successful retrieval, the API returns the following response:

{
  "models": [
    {
      "id": "c6b8a9f7e5d1c3a2f91e3",
      "name": "My model",
      "gender": "woman",
      "active": true,
      "created_at": "2024-04-01T12:00:00Z",
      "expire_at": "2024-05-01T12:00:00Z"
    },
    {
      "id": "d5c6b8a9f7e5d1c3a2f91",
      "name": "Another model",
      "gender": "man",
      "active": true,
      "created_at": "2024-04-05T15:30:00Z",
      "expire_at": "2024-05-05T15:30:00Z"
    }
  ],
  "total_models": 2
}

Last updated