POST
/
v1
/
namespaces
curl --request POST \
  --url https://api.mixpeek.com/v1/namespaces \
  --header 'Content-Type: application/json' \
  --data '{
  "namespace_name": "spotify_playlists_dev",
  "description": "This namespace contains playlists from Spotify",
  "feature_extractors": [
    {
      "description": "Text extractor",
      "feature_extractor_name": "text-extractor",
      "supported_input_types": [
        "text"
      ],
      "version": "1.0.0"
    }
  ],
  "payload_indexes": [
    {
      "field_name": "metadata.title",
      "field_schema": {
        "lowercase": true,
        "max_token_len": 15,
        "min_token_len": 2,
        "tokenizer": "word",
        "type": "text"
      },
      "type": "text"
    },
    {
      "field_name": "metadata.description",
      "field_schema": {
        "is_tenant": true,
        "type": "keyword"
      },
      "type": "keyword"
    }
  ]
}'
{
  "namespace_id": "<string>",
  "namespace_name": "<string>",
  "embedding_models": [
    "<string>"
  ],
  "payload_indexes": [
    "<any>"
  ]
}

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'

Body

application/json

Request schema for creating a new namespace

​
namespace_name
string
required

Name of the namespace to create

Example:

"spotify_playlists_dev"

​
description
string | null

Description of the namespace

Example:

"This namespace contains playlists from Spotify"

​
feature_extractors
object[]

List of feature extractors to use

Basic feature extractor model, used for creating namespaces.

Example:
[
  {
    "description": "Text extractor",
    "feature_extractor_name": "text-extractor",
    "supported_input_types": ["text"],
    "version": "1.0.0"
  }
]
​
payload_indexes
object[] | null

List of payload index configurations

Configuration for a payload index

Example:
[
  {
    "field_name": "metadata.title",
    "field_schema": {
      "lowercase": true,
      "max_token_len": 15,
      "min_token_len": 2,
      "tokenizer": "word",
      "type": "text"
    },
    "type": "text"
  },
  {
    "field_name": "metadata.description",
    "field_schema": { "is_tenant": true, "type": "keyword" },
    "type": "keyword"
  }
]

Response

200
application/json
Successful Response
​
namespace_id
string
required
​
namespace_name
string
required
​
embedding_models
string[]
required
​
payload_indexes
any[] | null
required

Was this page helpful?

Suggest editsRaise issue