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

List Collections

GET
/collections
GET
/collections
1import requests
2
3url = "https://api.airweave.ai/collections"
4
5headers = {"x-api-key": "<apiKey>"}
6
7response = requests.get(url, headers=headers)
8
9print(response.json())
1[
2  {
3    "name": "Finance Data",
4    "readable_id": "finance-data-ab123",
5    "id": "550e8400-e29b-41d4-a716-446655440000",
6    "created_at": "2024-01-15T09:30:00Z",
7    "modified_at": "2024-01-15T14:22:15Z",
8    "organization_id": "org12345-6789-abcd-ef01-234567890abc",
9    "vector_size": 1,
10    "embedding_model_name": "string",
11    "created_by_email": "admin@company.com",
12    "modified_by_email": "finance@company.com",
13    "status": "ACTIVE"
14  }
15]

Retrieve all collections belonging to your organization.

Collections are containers that group related data from one or more source connections, enabling unified search across multiple data sources.

Results are sorted by creation date (newest first) and support pagination and text search filtering.

Was this page helpful?
Previous

Get Collection

Next
Built with

Authentication

x-api-keystring
API Key authentication via header

Query parameters

skipintegerOptional>=0Defaults to 0
Number of collections to skip for pagination
limitintegerOptional1-1000Defaults to 100

Maximum number of collections to return (1-1000)

searchstringOptional

Search term to filter collections by name or readable_id

Response

Successful Response
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

422
Unprocessable Entity Error
429
Too Many Requests Error