Create Collection

POST/v1/memory/collections

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required
`tenantId`	`string`	No
`name`	`string`	No
`description`	`string`	No
`embeddingModel`	`string`	No
`embeddingDimension`	`integer`	No
`distanceMetric`	`string`	No
`metadata`	`object`	No

Responses

200 A successful response.

Property	Type	Description
`collection`	`object`	Collection represents a vector memory collection.

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/memory/collections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","name":"string","description":"string","embeddingModel":"string","embeddingDimension":0,"distanceMetric":"string"}'

const response = await fetch("http://localhost:8089/v1/memory/collections", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "embeddingModel": "string",
  "embeddingDimension": 0,
  "distanceMetric": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/memory/collections",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "embeddingModel": "string",
  "embeddingDimension": 0,
  "distanceMetric": "string"
},
)
data = response.json()

Response

{
  "collection": {
    "id": "string",
    "tenantId": "string",
    "name": "string",
    "description": "string",
    "embeddingModel": "string",
    "embeddingDimension": 0,
    "distanceMetric": "string",
    "documentCount": 0,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}