---
title: "Search platform secrets"
method: POST
path: "/platform/secret/search"
tags: ["Platform"]
---

# Search platform secrets

`POST /platform/secret/search`

## Request

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

## Request body

- object
  - `search` string, required: The search query to find relevant secrets
  - `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: 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 secret
    - `type` 'plain' | 'basic' | 'bearer' | 'jwt' | 'oauth' | 'template' | 'reference', required: The type of the secret
    - `kind` 'shared' | 'personal': The kind of the secret
    - `config` object
    - `icon` string
    - `tags` string[]
    - `setup` string
    - `commentary` string
    - `score` number, required: The text relevance score of the search result
    - `excerpt` string, required: An excerpt from the most relevant part of the secret
    - `link` string: The URL to the official secret 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)