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 '{
  "filters": {
    "description": "test",
    "namespace_name": {
      "$regex": "^my_namespace"
    }
  },
  "sort": {
    "direction": "asc",
    "field": "namespace_name"
  }
}'
{
  "pagination": {
    "has_more": false,
    "limit": 10,
    "skip": 0
  },
  "results": [
    {
      "description": "This namespace contains playlists from Spotify",
      "feature_extractors": [
        {
          "feature_extractor_name": "video_extractor",
          "version": "1.0.0"
        }
      ],
      "namespace_id": "ns_ab12cd34ef",
      "namespace_name": "spotify_playlists_dev",
      "payload_indexes": [
        {
          "field_name": "metadata.title",
          "type": "text"
        }
      ]
    }
  ],
  "total_count": 1
}

Headers

Authorization
string | null

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'

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request schema for listing namespaces.

filters
object | null

Optional filters to apply to the namespace list.

Example:
{
"description": "test",
"namespace_name": { "$regex": "^my_namespace" }
}
sort
object | null

Optional sort criteria for the namespace list.

Example:
{
"direction": "asc",
"field": "namespace_name"
}

Response

Successful Response

Response schema for listing namespaces.

results
NamespaceModel · object[]
required

List of namespaces matching the query

pagination
object
required

Pagination information for the current result window

total_count
integer
required

Total number of namespaces that match the query

I