---
title: "Get custom index reference"
method: GET
path: "/v1/custom-index/reference"
tags: ["Custom Index"]
---

# Get custom index reference

`GET /v1/custom-index/reference`

## Request

- Base URL: `https://api.liquidcompute.co`
- URL: `https://api.liquidcompute.co/v1/custom-index/reference`
- Auth: API key in header `X-API-Key`

Returns reference information for custom index endpoints available to your API key.

## Response `200`

Custom index reference information (authored by the gateway from this spec and your key's authorizations).

- CustomIndexReferenceResponse
  - `index_ids` string[], required: The custom index identifiers your key is authorized to read.
  - `default_index_id` string: The index used when index_id is omitted.
  - `index_units` string, required
  - `endpoints` object[], required
    - `path` string, required
    - `summary` string, required
    - `description` string
    - `parameters` object[], required

## Other responses

- `401`: Missing or invalid API key.
- `429`: Rate limit exceeded.
- `503`: API-key validation is temporarily unavailable.

---

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