Skip to main content
GET
/
api
/
v1
/
collections
curl -X GET "https://api.mielto.com/api/v1/collections?skip=0&limit=50&status=active" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "col_123456789",
      "name": "Product Documentation",
      "description": "All product documentation and guides",
      "store_type": "pgvector",
      "visibility": "private",
      "status": "active",
      "tags": ["docs", "product"],
      "stats": {
        "document_count": 42,
        "total_size_mb": 15.7,
        "last_updated": "2024-01-16T09:30:00Z"
      },
      "meta_data": {
        "category": "documentation"
      },
      "embedding": {
        "provider": "openai",
        "model": "text-embedding-ada-002",
        "dimensions": 1536
      },
      "workspace_id": "wsp_123456789",
      "created_by": "usr_123456789",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-16T09:30:00Z"
    }
  ],
  "total_count": 1
}

List Collections

Retrieve collections with pagination and filtering options. Collections are used to organize and store knowledge bases, documents, and other content.

Headers

Authorization
string
Bearer token for authentication
X-API-Key
string
API key for authentication (alternative to Authorization header)
X-Workspace-Id
string
Optional. Derived from API Key, but can be specified if you have access to multiple workspaces

Query Parameters

skip
integer
default:"0"
Number of collections to skip for pagination (minimum: 0)
limit
integer
default:"100"
Maximum number of collections to return (1-1000)
status
string
Filter by collection status (active, archived)
visibility
string
Filter by visibility (public, private)
Search collections by name or description
tags
string
Filter by tags (comma-separated)

Response

data
array
Array of collection objects
total_count
integer
Total number of collections matching the filters
curl -X GET "https://api.mielto.com/api/v1/collections?skip=0&limit=50&status=active" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "col_123456789",
      "name": "Product Documentation",
      "description": "All product documentation and guides",
      "store_type": "pgvector",
      "visibility": "private",
      "status": "active",
      "tags": ["docs", "product"],
      "stats": {
        "document_count": 42,
        "total_size_mb": 15.7,
        "last_updated": "2024-01-16T09:30:00Z"
      },
      "meta_data": {
        "category": "documentation"
      },
      "embedding": {
        "provider": "openai",
        "model": "text-embedding-ada-002",
        "dimensions": 1536
      },
      "workspace_id": "wsp_123456789",
      "created_by": "usr_123456789",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-16T09:30:00Z"
    }
  ],
  "total_count": 1
}