---
title: "Create a collection"
method: POST
path: "/api/v1/collections"
tags: ["Collections"]
---

# Create a collection

`POST /api/v1/collections`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/collections`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

## Request body

- CreateCollectionDto
  - `sandbox` boolean: Dashboard mode. API keys always use their authenticated mode.
  - `name` string, required
  - `description` string, nullable
  - `externalId` string: Immutable, case-sensitive external reference, unique per organization and mode even when archived.
  - `metadata` object: JSON object, at most 16 KiB of UTF-8 JSON.

## Response `201`

- CollectionDto
  - `id` string, uuid, required
  - `organizationId` string, uuid, required
  - `sandbox` boolean, required
  - `name` string, required
  - `description` string, nullable, required
  - `externalId` string, nullable, required
  - `metadata` object, required
  - `archivedAt` string, date-time, nullable, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `documentCount` number, required
  - `templateCount` number, required
  - `signingRequestCount` number, required: Signing requests started from this collection.

## Other responses

- `409`: externalId is already reserved in this organization and mode, including archived collections. Retrieve it using by-external-id.

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)