---
title: "Docs | Ceisium Search"
description: "Ceisium Search documentation for setup, crawl scope, indexing, the Search API, relevance tuning, observability, and security."
canonical: https://ceisium.com/docs/
---

> For the complete documentation and public content index, see [llms.txt](/llms.txt). This page is the Markdown alternative to the canonical HTML page.

## Start

1.  [Quickstart Create a project, crawl it, query the API, and embed search.](https://ceisium.com/docs/)
2.  [Search API Auth, request fields, response shape, pagination, errors, and examples.](https://ceisium.com/docs/search-api/)
3.  [UI Components Install search UI patterns and wire them to a Ceisium Search project.](https://ceisium.com/docs/ui-components/)
4.  [Analytics Read search events, no-result queries, popular queries, and engagement.](https://ceisium.com/docs/analytics/)

## Observability

1.  [Crawl Logs Track crawl status, page outcomes, failures, retries, and coverage.](https://ceisium.com/docs/crawl-logs/)
2.  [Usage Review API requests, crawl volume, indexing usage, and plan limits.](https://ceisium.com/docs/usage/)

1.  [Home](https://ceisium.com/)
2.  /
3.  [Docs](https://ceisium.com/docs/)
4.  /
5.  Quickstart

Updated Jul 12, 2026

# Quickstart

Create a project, crawl it, query the API, and embed search.

Browse docs

## Start

1.  [Quickstart](https://ceisium.com/docs/)
2.  [Search API](https://ceisium.com/docs/search-api/)
3.  [UI Components](https://ceisium.com/docs/ui-components/)
4.  [Analytics](https://ceisium.com/docs/analytics/)

## Observability

1.  [Crawl Logs](https://ceisium.com/docs/crawl-logs/)
2.  [Usage](https://ceisium.com/docs/usage/)

This guide uses [SigNoz opens in a new tab](https://signoz.io/)  as the example site. The same steps work for any public docs, changelog, blog, pricing, or product pages.

## 1\. Create a project

Create a Search project for the site you want visitors to search. Add the URL, crawl rules, crawl frequency, and page limit in one setup flow.

For SigNoz, use:

TXT

```
Project name: SigNozWebsite URL: https://signoz.ioInclude paths: /docs, /docs/**, /pricing, /pricing/**Exclude paths: noneCrawl frequency: DailyMax pages: 1,000
```

Click to pause Open full video

Create a SigNoz Search project by adding the site URL, include paths, crawl frequency, and page limit.

Create a SigNoz Search project by adding the site URL, include paths, crawl frequency, and page limit.

When the crawl finishes, the source should show indexed pages. For a SigNoz docs source, a useful crawl includes pages like `signoz.io/docs/install/`, `signoz.io/docs/instrumentation/`, and `signoz.io/docs/userguide/logs/`.

## 2\. Query the API

Create a **Browser/public key** for a website search box. Restrict it to the website origins where it may run, then call `/v1/search` directly from the browser. The browser supplies the `Origin` header automatically.

TS

```
const response = await fetch("https://api.ceisium.com/v1/search", {  method: "POST",  headers: {    Authorization: `Bearer ${CEISIUM_PUBLIC_SEARCH_KEY}`,    "Content-Type": "application/json",  },  body: JSON.stringify({    project_id: CEISIUM_PROJECT_ID,    query: "OpenTelemetry Python instrumentation",    top_k: 8,    path_prefix: "https://signoz.io/docs/",  }),});const { results } = await response.json();
```

If you configured allowed result URL prefixes on the key, send a matching `path_prefix` with every request.

## 3\. Embed search

Use a UI component when visitors should search inside your product site.

Start with one of these patterns:

-   Command palette for keyboard-first docs search.
-   Inline search for a visible search field on docs pages.
-   Search bar when the whole bar should open a modal.
-   Search modal for a SigNoz-style search overlay.

Use `CEISIUM_PUBLIC_SEARCH_KEY` only for a Browser/public key with its website and result restrictions configured. If you prefer to proxy searches through your backend, create a Server key, store it as `CEISIUM_SEARCH_KEY`, and never expose that key in browser code.

[Next Search API](https://ceisium.com/docs/search-api/)

Copy page

Copy page Copy page as Markdown for LLMs [ ![](https://www.google.com/s2/favicons?domain=chatgpt.com&sz=32)Open in ChatGPT ↗ Ask questions about this page ](https://chatgpt.com/?q=Use%20this%20documentation%20page%20as%20context%20and%20help%20me%20answer%20questions%20about%20it%3A%20Quickstart%20https%3A%2F%2Fceisium.com%2Fdocs%2F)[ ![](https://www.google.com/s2/favicons?domain=claude.ai&sz=32)Open in Claude ↗ Ask questions about this page](https://claude.ai/new?q=Use%20this%20documentation%20page%20as%20context%20and%20help%20me%20answer%20questions%20about%20it%3A%20Quickstart%20https%3A%2F%2Fceisium.com%2Fdocs%2F)