---
title: "Search platform examples"
method: POST
path: "/platform/example/search"
tags: ["Platform"]
---

# Search platform examples

`POST /platform/example/search`

## Request

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

## Request body

- object
  - `search` string, required: The search query to find relevant examples
  - `take` integer: The maximum number of results to return (1-100, default 10)

## Response `200`

The search was successful

- object
  - `items` object[], required
    - `name` string, required: The associated name
    - `description` string, required: 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` 'blueprint' | 'project' | 'widget' | 'slack' | 'discord' | 'whatsapp' | 'messenger' | 'telegram' | 'twilio' | 'email' | 'trigger', required: The type of the example
    - `tags` string[]: Tags associated with the example
    - `link` string, required: The URL to the official example 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)