---
title: "Create a custom index"
method: POST
path: "/v1/indexes"
---

# Create a custom index

`POST /v1/indexes`

## Request

- Base URL: `https://api.typesearch.ai`
- URL: `https://api.typesearch.ai/v1/indexes`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

A custom index is your own list of URLs, searched with the same relevance model as the news index: pass its id as `index` to POST /v1/search. Pay as you go allows 3 indexes and 100 URLs; the Monthly credit plan 50 and 10,000; Enterprise, unlimited.

## Request body

- IndexRequest
  - `name` string, required

## Response `201`

The index that was created.

- Index
  - `id` string, required
  - `object` 'index', required
  - `name` string, required
  - `status` 'active' | 'paused', required: paused: no credit left, so it is not re-read (nor billed) until there is.
  - `urls` object, required
    - `total` integer, required
    - `ready` integer, required
    - `pending` integer, required
    - `failed` integer, required
    - `blocked` integer, required
  - `sources` object[], required: Sitemaps and feeds: read every hour; new URLs are added (up to your limit) and updated ones re-read.
    - `url` string, required
    - `type` 'sitemap' | 'feed', required
    - `status` 'pending' | 'ok' | 'failed', required
    - `read_at` string, nullable, required
    - `urls` integer, required: URLs it listed the last time it was read.
    - `error` string, nullable, required
  - `cost_per_day_usd` number, required: What its URLs cost per day right now (US$2.00 per 1,000 URLs per month, a thirtieth per day).
  - `last_read_at` string, nullable, required
  - `created_at` string, required
  - `updated_at` string, required

## Other responses

- `402`: Payment required: `insufficient_credits` (no credit left), `spend_limit_reached` (the key hit its monthly limit) or `budget_too_small`.
- `409`: `index_limit_reached`: your plan allows no more indexes.
- `default`: Error (RFC 9457). In English unless the request sends `Accept-Language: es`.

---

[API](https://skmtc.dev/typesearch/apis/typesearch-news-search-api.md) · [All operations](https://skmtc.dev/typesearch/apis/typesearch-news-search-api/llms.txt) · [OpenAPI document](https://skmtc.dev/typesearch/apis/typesearch-news-search-api/revisions/b270b9a9c6a5?raw)