AIairweave-ai
collections

List Collections

Changed on

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.

get/collections

Request

  • Base URL
    https://api.airweave.ai
  • Auth
    API key in header x-api-key

Query parameters

skipinteger

Number of collections to skip for pagination

limitinteger

Maximum number of collections to return (1-1000)

Example:100
searchstring

Search term to filter collections by name or readable_id

Example:customer

Response

Successful Response

namestring required

Human-readable display name for the collection.

readable_idstring required

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

idstring uuid required

Unique system identifier for the collection. This UUID is generated automatically and used for internal references.

created_atstring date-time required

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

modified_atstring date-time required

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

organization_idstring uuid required

Identifier of the organization that owns this collection. Collections are isolated per organization.

created_by_emailstring email nullable

Email address of the user who created this collection.

modified_by_emailstring email nullable

Email address of the user who last modified this collection.

status'ACTIVE' | 'NEEDS SOURCE' | 'ERROR'

Collection status enum.

vector_sizeinteger required

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

embedding_model_namestring required

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

Example response

[
  {
    "created_at": "2024-01-15T09:30:00Z",
    "created_by_email": "admin@company.com",
    "embedding_model_name": "text-embedding-3-large",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "modified_at": "2024-01-15T14:22:15Z",
    "modified_by_email": "finance@company.com",
    "name": "Finance Data",
    "organization_id": "org12345-6789-abcd-ef01-234567890abc",
    "readable_id": "finance-data-ab123",
    "source_connection_summaries": [
      {
        "name": "Slack",
        "short_name": "slack"
      },
      {
        "name": "GitHub",
        "short_name": "github"
      }
    ],
    "status": "ACTIVE",
    "vector_size": 3072
  }
]

Changes

  • a8105b372b4dRevision changes
    • info

      added the optional property / to the response with the status

  • 573e671e8777Revision changes
    • warning

      removed the optional property //// from the response with the status