---
title: "Search a custom index"
method: POST
path: "/v1/indexes/{index_id}/search"
tags: ["Search"]
---

# Search a custom index

`POST /v1/indexes/{index_id}/search`

## Request

- Base URL: `https://cold-api.coldstate.ai`
- URL: `https://cold-api.coldstate.ai/v1/indexes/{index_id}/search`
- Auth: HTTP bearer

## Path parameters

- `index_id` string, required

## Request body

- IndexSearchRequest
  - `query` string, required
  - `limit` integer
  - `offset` integer

## Response `200`

OK

- IndexSearchResponse
  - `index_id` string
  - `collection` string
  - `query` string
  - `results` object[]
    - `id` string
    - `ref_id` string
    - `metadata` object
    - `score` Score
      - `Ψ` number, required
    - `state` 'CRYSTALLINE' | 'FLUID' | 'REACTIVE' | 'DECOHERENT': Result confidence state derived from the Ψ score
  - `diagnostics` object
  - `pagination` Pagination
    - `offset` integer
    - `limit` integer
    - `total` integer
    - `has_more` boolean

## Other responses

- `400`: Validation error or index not ready
- `401`: Missing or invalid API key
- `403`: Not your index
- `404`: Not found
- `429`: Rate or quota limit exceeded

---

[API](https://skmtc.dev/coldstate/apis/coldstate-api.md) · [All operations](https://skmtc.dev/coldstate/apis/coldstate-api/llms.txt) · [OpenAPI document](https://skmtc.dev/coldstate/apis/coldstate-api/revisions/609b567f955c?raw)