For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Fork this repoGet a demo
  • Docs
    • Welcome
    • Quickstart
    • Concepts
    • Search
    • MCP Server
    • CLI
    • Agent Skills
    • Connect
    • Add New Connector
    • Rate Limits
  • API Reference
      • GETList Collections
      • GETGet Collection
      • POSTCreate Collection
      • PATCHUpdate Collection
      • DELDelete Collection
      • POSTInstant Search
      • POSTClassic Search
      • POSTAgentic Search
      • STREAMStream Agentic Search
LogoLogo
Fork this repoGet a demo
API ReferenceCollections

Update Collection

PATCH
/collections/:readable_id
PATCH
/collections/:readable_id
1import requests
2
3url = "https://api.airweave.ai/collections/customer-support-tickets-x7k9m"
4
5payload = { "name": "Updated Finance Data" }
6headers = {
7    "x-api-key": "<apiKey>",
8    "Content-Type": "application/json"
9}
10
11response = requests.patch(url, json=payload, headers=headers)
12
13print(response.json())
1{
2  "name": "Finance Data",
3  "readable_id": "finance-data-ab123",
4  "id": "550e8400-e29b-41d4-a716-446655440000",
5  "created_at": "2024-01-15T09:30:00Z",
6  "modified_at": "2024-01-15T14:22:15Z",
7  "organization_id": "org12345-6789-abcd-ef01-234567890abc",
8  "vector_size": 3072,
9  "embedding_model_name": "text-embedding-3-large",
10  "created_by_email": "admin@company.com",
11  "modified_by_email": "finance@company.com",
12  "status": "ACTIVE",
13  "source_connection_summaries": [
14    {
15      "short_name": "slack",
16      "name": "Slack"
17    },
18    {
19      "short_name": "github",
20      "name": "GitHub"
21    }
22  ]
23}
Update an existing collection's properties. You can modify: - **Name**: The display name shown in the UI - **Sync configuration**: Schedule settings for automatic data synchronization Note that the `readable_id` cannot be changed after creation to maintain stable API endpoints and preserve existing integrations.
Was this page helpful?
Previous

Delete Collection

Next
Built with

Update an existing collection’s properties.

You can modify:

  • Name: The display name shown in the UI
  • Sync configuration: Schedule settings for automatic data synchronization

Note that the readable_id cannot be changed after creation to maintain stable API endpoints and preserve existing integrations.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

readable_idstringRequired
The unique readable identifier of the collection to update

Request

This endpoint expects an object.
namestring or nullOptional4-64 characters
Updated display name for the collection. Must be between 4 and 64 characters.
sync_configobject or nullOptional

Default sync configuration for all syncs in this collection. This provides collection-level defaults that can be overridden at sync or job level.

Response

Updated collection
namestring

Human-readable display name for the collection.

readable_idstring

URL-safe unique identifier used in API endpoints. This becomes non-optional once the collection is created.

idstringformat: "uuid"
Unique system identifier for the collection. This UUID is generated automatically and used for internal references.
created_atstringformat: "date-time"

Timestamp when the collection was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the collection was last modified (ISO 8601 format).

organization_idstringformat: "uuid"
Identifier of the organization that owns this collection. Collections are isolated per organization.
vector_sizeinteger

Vector dimensions used by this collection (derived from deployment metadata).

embedding_model_namestring

Name of the embedding model used for this collection (derived from deployment metadata).

sync_configobject or null
Default sync configuration for all syncs in this collection. Overridable at sync and job level.
created_by_emailstring or nullformat: "email"
Email address of the user who created this collection.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this collection.
statusenum

Current operational status of the collection:
• NEEDS_SOURCE: Collection has no authenticated connections, or connections exist but haven’t synced yet
• ACTIVE: At least one connection has completed a sync or is currently syncing
• ERROR: All connections have failed their last sync

Allowed values:
source_connection_summarieslist of objects

Lightweight list of source connections attached to this collection. Contains only short_name and name, suitable for rendering icons in list views.

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error