---
title: "Create an index (async build)"
method: POST
path: "/v1/indexes"
tags: ["Indexes"]
---

# Create an index (async build)

`POST /v1/indexes`

## Request

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

## Request body

- CreateIndexRequest
  - `name` string, required
  - `description` string
  - `collection_name` string
  - `domain_preset` 'general' | 'medical' | 'biomedical' | 'scientific' | 'technical' | 'legal' | 'financial' | 'ecommerce'
  - `mode` 'hosted' | 'iaas'
  - `webhook_url` string, uri
  - `settings` object
  - `documents` Document[]
    - `content` string, required
    - `ref_id` string: Your reference id; the only identifier stored
    - `metadata` object

## Response `202`

Queued; poll GET /v1/indexes/{index_id}

## Other responses

- `400`: Validation error or plan limit
- `401`: Missing or invalid API key
- `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)
