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

# Retrieve a list of platform abilities

`GET /platform/ability/list`

## Request

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

## Query parameters

- `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 abilities 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
    - `template` string: The original template identifier for the ability
    - `instruction` string, required
    - `schema` JsonSchemaObject, required: A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules.
      - `type` 'object', required: The schema type, must be "object"
      - `title` string: The schema title
      - `description` string: The schema description
      - `properties` object, required: Object property definitions
      - `required` string[]: Required property names
    - `bot` string: The ID of the bot associated with the ability
    - `file` string: The ID of the file associated with the ability
    - `secret` string: The ID of the secret associated with the ability
    - `space` string: The ID of the space associated with the ability
    - `computer` string: Set when the ability can run on a linked computer
    - `provider` string: The provider of the ability
    - `icon` string, required
    - `tags` string[]
    - `setup` string
    - `commentary` string
  - `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)
