---
title: "Retrieve a list of platform models"
method: GET
path: "/platform/model/list"
tags: ["Platform"]
---

# Retrieve a list of platform models

`GET /platform/model/list`

## Request

- Base URL: `https://api.chatbotkit.com/api/v1`
- URL: `https://api.chatbotkit.com/api/v1/platform/model/list`
- Auth: HTTP bearer

## Query parameters

- `type` 'language' | 'image' | 'video' | 'rerank' | 'decision': The type of models to list
- `cursor` string: The cursor to use for pagination
- `order` 'asc' | 'desc': The order of the paginated items
- `take` integer: The number of items to retrieve
- `meta` object: Key-value pairs to filter the items by metadata

## Response `200`

The list of models was retrieved successfully

- object
  - `items` object[], required
    - `name` string: The associated name
    - `description` string: The associated description
    - `meta` Meta: Meta data information
    - `id` string, required: The instance ID
    - `createdAt` number, required: The timestamp (ms) when the instance was created
    - `updatedAt` number, required: The timestamp (ms) when the instance was updated
    - `type` 'language' | 'image' | 'video' | 'rerank' | 'decision', required: The type of the model
    - `default` boolean: Whether this model is the deployment's default for its type
    - `provider` string, required: The backstory of the model
    - `family` string, required: The model of the model
    - `maxTokens` number, required: The maximum number of tokens the model can use
    - `maxInputTokens` number, required: The maximum number of tokens the model can accept
    - `maxOutputTokens` number, required: The maximum number of tokens the model can generate
  - `cursor` string, required: Cursor for fetching the next page

## Other responses

- `default`: An error response

---

[API](https://skmtc.dev/chatbotkit/apis/cbk-api.md) · [All operations](https://skmtc.dev/chatbotkit/apis/cbk-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatbotkit/apis/cbk-api/revisions/13d250576136?raw)