---
title: "Convenience: create-or-append documents to a collection"
method: POST
path: "/v1/index"
tags: ["Indexes"]
---

# Convenience: create-or-append documents to a collection

`POST /v1/index`

## Request

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

## Request body

- ConvenienceIndexRequest
  - `collection` string, required
  - `name` string
  - `domain_preset` string
  - `documents` Document[]
    - `content` string, required
    - `ref_id` string: Your reference id; the only identifier stored
    - `metadata` object

## Response `202`

Queued

## 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)