---
title: "Search relevant references associated with the search query."
method: POST
path: "/search"
tags: ["API: Search"]
---

# Search relevant references associated with the search query.

`POST /search`

This endpoint is a scaled down version of the messaging API. It will only search and return relevant references based on the search query.

## Request body

- SearchReferencesOptions
  - `searchQuery` string, text, required — Content of the search query.
  - `channelId` string, uuid, required — ID of the channel on who's content should be searched.
  - `limit` integer — A number indicating how many results should it return at most. Default is 50.

## Response `200`

A response containing a list of references if references were identified, otherwise an empty array.

- SearchReferences
  - `searchReferences` object[], required
    - `id` string, uuid, required — ID of the content record.
    - `title` string, required — Title of the main/source media.
    - `source` 'YOUTUBE' | 'VIMEO' | 'WEBSITE' | 'VIDEO' | 'SPOTIFY', required — Source of the content to be used for handling its display/linking to the user.
    - `url` string, url, required — Original URL of the content. Used for linking to external websites of the source.
    - `urlContentId` string, required — Original ID of the media from the given source. It can be used to generate an iframe/embed url when displaying the content from the reference.
    - `thumbnailUrl` string, url — Image URL of the content.
    - `relevanceRank` integer, required — Rank of relevance of the reference to the search query.

## Other responses

- `422` — Some or all of the received payload is unprocessable.
- `500` — Internal server error

---

[API](https://skmtc.dev/sentiyen/apis/sentiyen-api-v3.md) · [All operations](https://skmtc.dev/sentiyen/apis/sentiyen-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sentiyen/sentiyen-api-v3/revisions/8ce4e621146e/schema)
