Update collection metadata

Updates the description, settings, or the agent_ids sharing list. To evolve the schema after creation, use the schema and indexes endpoints instead.

PATCH /v1/collections/{collection_id}

Update collection metadata

cURL

curl --request PATCH \
  --url https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/collections/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "settings": {
    "ttl_days": 1,
    "max_records": 123
  },
  "agent_ids": [
    "agent_123",
    "agent_456"
  ]
}
'

200

{
  "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "products",
  "description": "<string>",
  "owner_id": "<string>",
  "owner_type": "user",
  "agent_ids": [
    "<string>"
  ],
  "orgSlug": "<string>",
  "settings": {
    "ttl_days": 1,
    "max_records": 123
  },
  "schema": {
    "product_name": {
      "type": "text"
    },
    "price": {
      "type": "double"
    },
    "stock": {
      "type": "integer",
      "nullable": true
    },
    "active": {
      "type": "boolean"
    },
    "released_at": {
      "type": "date"
    },
    "specs": {
      "type": "json"
    }
  },
  "indexes": [
    {
      "properties": [
        "sku"
      ]
    }
  ],
  "uniques": [
    {
      "properties": [
        "sku"
      ]
    }
  ],
  "charts": [
    {
      "id": "<string>",
      "kind": "bar",
      "title": "<string>",
      "agg": "count",
      "field": "<string>",
      "dimension": "<string>"
    }
  ],
  "row_count": 123,
  "status": "ready"
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User session JWT. Send as Authorization: Bearer <token>.

Path Parameters

collection_id · string<uuid> · required

Collection identifier returned at creation.

Body

application/json

description · string

settings · object

Hide child attributes

settings. ttl_days · integer

Default record expiration in days (0 = never).

Required range: x >= 0

settings. max_records · integer

Collection size limit (default 10,000).

agent_ids · string[]

Agents granted access to this collection.

Example:

["agent_123", "agent_456"]

Response

200

application/json

Updated collection metadata.

collection_id · string<uuid>

name · string

Example:

"products"

description · string

owner_id · string

User ID or agent ID owning the collection.

owner_type · enum<string>

Available options: user, agent

agent_ids · string[]

Agents granted access (sharing list).

orgSlug · string

Organization the collection belongs to (tenant boundary).

settings · object

Hide child attributes

settings. ttl_days · integer

Default record expiration in days (0 = never).

Required range: x >= 0

settings. max_records · integer

Collection size limit (default 10,000).

schema · object

Column definitions: field name → type descriptor.

Hide child attributes

schema. {key} · object

Hide child attributes

schema.{key}. type · enum<string> · required

Available options: text, integer, double, boolean, date, datetime, json, array

schema.{key}. nullable · boolean

Example:

{
  "product_name": { "type": "text" },
  "price": { "type": "double" },
  "stock": { "type": "integer", "nullable": true },
  "active": { "type": "boolean" },
  "released_at": { "type": "date" },
  "specs": { "type": "json" }
}

indexes · object[]

Hide child attributes

indexes. properties · string[] · required

Example:

["sku"]

uniques · object[]

Hide child attributes

uniques. properties · string[] · required

Example:

["sku"]

charts · object[]

Hide child attributes

charts. id · string

charts. kind · string

e.g. kpi, bar, line.

Example:

"bar"

charts. title · string

charts. agg · string

Example:

"count"

charts. field · string

charts. dimension · string

row_count · integer

On list with with_counts=true, an estimated count; null otherwise.

status · string

Example:

"ready"