Skip to main content
POST
/
v1
/
namespaces
/
list
List Namespaces
curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "case_sensitive": false
}
'
{
  "results": [
    {
      "namespace_name": "spotify_playlists_dev",
      "namespace_id": "<string>",
      "infrastructure": {
        "autoscaling_enabled": false,
        "compute_tier": "shared",
        "description": "Shared development namespace",
        "max_concurrent_jobs": 10,
        "qdrant_collection": "ns_dev",
        "ray_head_node_url": "ray://shared-cluster:10001"
      },
      "cluster_id": "iclstr_abc123xyz",
      "description": "<string>",
      "feature_extractors": [
        {
          "feature_extractor_name": "<string>",
          "version": "<string>",
          "feature_extractor_id": "<string>"
        }
      ],
      "payload_indexes": [
        {
          "field_name": "<string>",
          "type": "keyword",
          "field_schema": {
            "type": "text",
            "tokenizer": "word",
            "min_token_len": 2,
            "max_token_len": 15,
            "lowercase": true
          },
          "is_protected": false
        }
      ],
      "document_count": 123,
      "auto_create_indexes": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  },
  "total_count": 123,
  "stats": {
    "total_feature_extractors": 0,
    "total_payload_indexes": 0,
    "total_documents": 0,
    "avg_feature_extractors_per_namespace": 0,
    "avg_payload_indexes_per_namespace": 0,
    "avg_documents_per_namespace": 0
  }
}

Headers

Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request schema for listing namespaces.

filters
Filters · object

Optional filters to apply to the namespace list.

Example:
{
"description": "test",
"namespace_name": { "$regex": "^my_namespace" }
}
sort
Sort · object

Optional sort criteria for the namespace list.

Example:
{
"direction": "asc",
"field": "namespace_name"
}
search
string | null

Search term for wildcard search across all text fields.

Example:

"production"

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response schema for listing namespaces.

results
NamespaceModel · object[]
required

List of namespaces matching the query

pagination
PaginationResponse · object
required

Pagination information for the current result window

total_count
integer
required

Total number of namespaces that match the query

stats
NamespaceListStats · object

Aggregate statistics across all namespaces in the result