Managing Collections

Collections are the primary way to organize your documents in aqoon. Think of them as folders — each collection groups related documents together and gets its own search index.

Creating a Collection

1. Click Collections in the sidebar
2. Click New Collection
3. Enter a name and an optional description
4. Click Save

Your new collection is ready. You can now upload documents into it.

Viewing Your Collections

The collections page shows all collections you own plus any public collections you've subscribed to. Each collection card shows:

• Collection name
• Number of documents
• A Public badge if the collection is publicly shared
• A Subscribed badge for public collections you've joined

Click any card to open the collection detail page.

Collection Detail Page

The detail page lists all documents in the collection as a table with:

Column	Description
Title	Document name (click to view details)
Source	Type of upload: PDF, DOCX, Image, Markdown, Text, Spreadsheet, or URL
Status	Processing state: Pending, Processing, Indexed, or Failed
Chunks	Number of text segments extracted from the document
Tags	Tags assigned during upload
Uploaded	When the document was added

Editing a Collection

From the collection detail page, click Edit in the top-right to change the collection's name or description.

Deleting a Collection

Click Delete on the collection detail page. This removes the collection and all its documents. This action cannot be undone.

Only the collection owner — or an API key with write permission — can edit, delete, or upload documents. If you've subscribed to someone else's public collection, you have read-only access.

Managing Collections via API

You can create, update, and delete collections programmatically using the REST API or the official SDKs. All write operations require a full-access API key or a scoped key with write permission on the collection.

Create a Collection

curl

curl -X POST https://your-instance/api/v1/collections/ \
  -H "Authorization: Bearer aqn_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Docs", "description": "Optional description"}'

Python SDK

collection = client.create_collection("My Docs", description="Optional description")
print(collection["uuid"])   # use this uuid to upload documents

JavaScript SDK

const collection = await client.createCollection("My Docs", { description: "Optional description" });
console.log(collection.uuid); // use this uuid to upload documents

Update a Collection

curl

curl -X PATCH https://your-instance/api/v1/collections/{uuid}/ \
  -H "Authorization: Bearer aqn_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Renamed Docs"}'

Python SDK

collection = client.update_collection("collection-uuid", name="Renamed Docs")
print(collection["name"])

JavaScript SDK

const updated = await client.updateCollection("collection-uuid", { name: "Renamed Docs" });
console.log(updated.name);

Delete a Collection

Deletes the collection and all its documents. Search index entries are removed immediately; blobs are retained for a 7-day grace period. This operation cannot be undone.

curl

curl -X DELETE https://your-instance/api/v1/collections/{uuid}/ \
  -H "Authorization: Bearer aqn_your_api_key" \
  -w "\nHTTP %{http_code}\n"
# HTTP 204

Python SDK

client.delete_collection("collection-uuid")
# Returns None on success (HTTP 204)

JavaScript SDK

await client.deleteCollection("collection-uuid");
// Returns undefined on success (HTTP 204)