Update Collection

curl --request PUT \
  --url https://api.example.com/api/collections/{collection_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "openapi_spec": {}
}
'

PUT

api

collections

{collection_id}

Update Collection

curl --request PUT \
  --url https://api.example.com/api/collections/{collection_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "openapi_spec": {}
}
'

Authentication

Authorization

string

required

Bearer token: Bearer <admin_token>

This endpoint requires admin privileges.

Path Parameters

collection_id

string

required

Collection ID (UUID)

Request Body

name

string

Updated collection name

description

string

Updated description

openapi_spec

object

Updated OpenAPI specification

Example Request

curl -X PUT https://api.sari-platform.com/api/collections/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <admin_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Name",
    "description": "Updated description"
  }'

Response

Returns the updated collection object.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated Name",
  "description": "Updated description",
  "updated_at": "2024-01-16T12:00:00Z"
}

What Happens

Collection Updated - Changes saved to database
Vector Regenerated - If name/description changed, embedding updated
Cache Invalidated - All related caches cleared

Errors

Status	Description
400	Invalid request body
401	Invalid or expired token
403	Admin access required
404	Collection not found

Create Collection Delete Collection

​Authentication

​Path Parameters

​Request Body

​Example Request

​Response

​What Happens

​Errors

Authentication

Path Parameters

Request Body

Example Request

Response

What Happens

Errors