Health
Collections
Collection Documents
Collection Features
Retriever Stages
Taxonomies
Clusters
Retriever Interactions
Namespaces
Research
Get Collection
curl --request GET \
--url https://api.mixpeek.com/v1/collections/{collection_id}{
"collection_name": "<string>",
"collection_id": "<string>",
"description": "<string>",
"metadata": {},
"enabled": true,
"source_lineage": [
{
"source_type": "bucket",
"collection_id": "<string>",
"bucket_id": "<string>",
"bucket_config": {
"type": "bucket",
"bucket_id": "<string>",
"prefix_key": "<string>",
"collection_id": "<string>",
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
}
},
"collection_config": {
"type": "bucket",
"bucket_id": "<string>",
"prefix_key": "<string>",
"collection_id": "<string>",
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
}
},
"feature_extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"parameters": {},
"input_mapping": {},
"output_mapping": {},
"document_output_type": "single",
"document_input_handling": "individual",
"document_output_handling": "create_new"
}
],
"output_schema": {
"properties": {}
}
}
],
"feature_extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"parameters": {},
"input_mapping": {},
"output_mapping": {},
"document_output_type": "single",
"document_input_handling": "individual",
"document_output_handling": "create_new"
}
],
"status": "DONE",
"output_schema": {
"properties": {}
},
"taxonomy_applications": [
{
"taxonomy_id": "<string>",
"output_collection": "<string>"
}
],
"cache_config": {
"enabled": true,
"ttl_seconds": 604800,
"invalidation_strategy": "replace_if_better",
"max_entries_per_key": 5,
"score_threshold": 123,
"invalidation_events": [
{
"collection": "<string>",
"action": "<string>",
"recompute_strategy": "background",
"retriever_id": "<string>"
}
],
"retriever_configs": {}
}
}Headers
Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'
Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
Path Parameters
The ID of the collection to retrieve
Response
Collection model defining the high-level structure and behavior of a collection. Collections are created and modified through feature extractors, which define their own document handling behavior (create/enrich/replace) through their document_output_handling settings.
Name for the collection
List of feature extractor configurations used to create the collection
Configuration for a feature extractor that is selected for use within a collection. This model represents a selected feature extractor along with its specific configuration for a particular collection. This gets stored in the collection settings.
Name of the feature extractor
Version of the feature extractor
Custom parameters for the extractor
Maps pipeline inputs to extractor inputs (source -> target)
Maps extractor outputs to pipeline outputs (source -> target)
Type of document output produced by the extractor
single, multiple How documents are provided to the extractor
individual, grouped How extractor output is handled for documents
create_new Schema for the collection determined by the feature extractors and their outputs
Schema field definition for bucket objects
Enum for field types in bucket schemas
string, number, integer, boolean, object, array, date, datetime, json, text, image, audio, video, pdf, document, spreadsheet, presentation, dense_vector, sparse_vector, int8_vector Schema field definition for bucket objects
Enum for field types in bucket schemas
string, number, integer, boolean, object, array, date, datetime, json, text, image, audio, video, pdf, document, spreadsheet, presentation, dense_vector, sparse_vector, int8_vector Schema field definition for bucket objects
Unique identifier for the collection
Description for the collection
Optional metadata for the collection
Enable or disable processing of this collection
Ordered list of lineage entries, from source to this collection
A single entry in the collection lineage path
Type of this entry
bucket, collection Output schema
Schema field definition for bucket objects
Enum for field types in bucket schemas
string, number, integer, boolean, object, array, date, datetime, json, text, image, audio, video, pdf, document, spreadsheet, presentation, dense_vector, sparse_vector, int8_vector Schema field definition for bucket objects
ID of this entry (collection_id)
ID of this entry (bucket_id)
Bucket details if this is a bucket or using a bucket source
Type of source (bucket or collection)
bucket, collection ID of the source bucket
Optional prefix to filter bucket objects
ID of the source collection
Optional filters to apply to the source collection
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
Collection details if this is a collection or using a collection source
Type of source (bucket or collection)
bucket, collection ID of the source bucket
Optional prefix to filter bucket objects
ID of the source collection
Optional filters to apply to the source collection
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
Feature extractors applied
Configuration for a feature extractor that is selected for use within a collection. This model represents a selected feature extractor along with its specific configuration for a particular collection. This gets stored in the collection settings.
Name of the feature extractor
Version of the feature extractor
Custom parameters for the extractor
Maps pipeline inputs to extractor inputs (source -> target)
Maps extractor outputs to pipeline outputs (source -> target)
Type of document output produced by the extractor
single, multiple How documents are provided to the extractor
individual, grouped How extractor output is handled for documents
create_new Status of the feature extractors in this collection
DONE, FAILED, SKIPPED, CANCELLED, PROCESSING, DOWNLOADING, INITIALIZING, UPLOADING, QUEUED, PENDING, CONVERTING List of taxonomy application configurations
Configuration for how a taxonomy should be applied and materialized
ID of the taxonomy to apply
ID or name of the collection to store enriched documents, if none exists, it will be created.
If set to None, it will be treated as a temporary enrichment and not stored.
Configuration for collection-level caching
Whether caching is enabled
Time-to-live for cache entries in seconds
Strategy for handling cache invalidation
replace_if_better, replace_always, keep_existing Maximum number of results to cache per key
Minimum score threshold for caching results
Events that trigger cache invalidation
Event that triggers cache invalidation
Collection ID to monitor
Action that triggers invalidation (create, update, delete)
Strategy for recomputing invalidated entries
immediate, background, lazy Optional retriever ID for retriever-specific invalidation
Retriever-specific cache configurations
Configuration for retriever-specific caching
Whether caching is enabled for this retriever
Optional retriever-specific TTL override
Optional retriever-specific score threshold
Was this page helpful?
curl --request GET \
--url https://api.mixpeek.com/v1/collections/{collection_id}{
"collection_name": "<string>",
"collection_id": "<string>",
"description": "<string>",
"metadata": {},
"enabled": true,
"source_lineage": [
{
"source_type": "bucket",
"collection_id": "<string>",
"bucket_id": "<string>",
"bucket_config": {
"type": "bucket",
"bucket_id": "<string>",
"prefix_key": "<string>",
"collection_id": "<string>",
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
}
},
"collection_config": {
"type": "bucket",
"bucket_id": "<string>",
"prefix_key": "<string>",
"collection_id": "<string>",
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
}
},
"feature_extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"parameters": {},
"input_mapping": {},
"output_mapping": {},
"document_output_type": "single",
"document_input_handling": "individual",
"document_output_handling": "create_new"
}
],
"output_schema": {
"properties": {}
}
}
],
"feature_extractors": [
{
"feature_extractor_name": "<string>",
"version": "<string>",
"parameters": {},
"input_mapping": {},
"output_mapping": {},
"document_output_type": "single",
"document_input_handling": "individual",
"document_output_handling": "create_new"
}
],
"status": "DONE",
"output_schema": {
"properties": {}
},
"taxonomy_applications": [
{
"taxonomy_id": "<string>",
"output_collection": "<string>"
}
],
"cache_config": {
"enabled": true,
"ttl_seconds": 604800,
"invalidation_strategy": "replace_if_better",
"max_entries_per_key": 5,
"score_threshold": 123,
"invalidation_events": [
{
"collection": "<string>",
"action": "<string>",
"recompute_strategy": "background",
"retriever_id": "<string>"
}
],
"retriever_configs": {}
}
}