Skip to main content
GET
/
v1
/
collections
/
{readable_id}
Get Collection
curl --request GET \
  --url https://api.example.com/v1/collections/{readable_id}
{
  "id": "<string>",
  "name": "<string>",
  "readable_id": "<string>",
  "status": "<string>",
  "vector_size": 123,
  "embedding_model_name": "<string>",
  "organization_id": "<string>",
  "created_at": "<string>",
  "modified_at": "<string>",
  "created_by_email": "<string>",
  "modified_by_email": "<string>",
  "sync_config": {}
}

​
Overview

Retrieve complete details of a specific collection by its readable ID. Returns the collection configuration including sync settings, status, and metadata. Use this to check the current state of a collection or to get configuration details before making updates.

​
Path Parameters

​
readable_id
string
required
The unique readable identifier of the collection (e.g., ‘finance-data-ab123’)

​
Response

Returns a single collection object.
​
id
string
required
Unique UUID identifier for the collection
​
name
string
required
Human-readable display name
​
readable_id
string
required
URL-safe unique identifier used in API endpoints
​
status
string
required
Current operational status: NEEDS_SOURCE, ACTIVE, or ERROR
​
vector_size
integer
required
Vector dimensions used by this collection
​
embedding_model_name
string
required
Name of the embedding model used
​
organization_id
string
required
UUID of the organization that owns this collection
​
created_at
string
required
ISO 8601 timestamp when created
​
modified_at
string
required
ISO 8601 timestamp when last modified
​
created_by_email
string
Email of the user who created this collection
​
modified_by_email
string
Email of the user who last modified this collection
​
sync_config
object
Default sync configuration for all syncs in this collection

​
Example Request

curl https://api.airweave.ai/v1/collections/finance-data-ab123 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

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

​
Error Responses

​
404 Not Found
Collection with the specified readable_id does not exist