Sign in

v10

latestOpenAPI 3.1.02026-08-085671,1112.8 MB
Namespaces

List Namespaces

List all namespaces for a user

post/v1/namespaces/list

Query parameters

include_systemboolean

Include read-only system namespaces (e.g. sample-data)

Include read-only system namespaces (e.g. sample-data)

view'full' | 'summary'

Response detail level. 'full' (default) returns complete namespace objects. 'summary' omits heavy per-namespace config (payload_indexes, feature_extractors, vector_inference_map, vector_configs) — ~93% smaller — for high-frequency list/switcher views. Fetch full config via GET /v1/namespaces/{namespace_identifier}.

Response detail level. 'full' (default) returns complete namespace objects. 'summary' omits heavy per-namespace config (payload_indexes, feature_extractors, vector_inference_map, vector_configs) — ~93% smaller — for high-frequency list/switcher views. Fetch full config via GET /v1/namespaces/{namespace_identifier}.

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

limitinteger nullable

Page size. A body value wins over the limit query param.

page_sizeinteger nullable

Alias for limit (page size). If both are given, limit wins.

offsetinteger nullable

Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.

pageinteger nullable

1-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.

filtersobject nullable

Optional filters to apply to the namespace list. Supports filtering by namespace_id or namespace_name.

sortobject nullable

Optional sort criteria for the namespace list (single-column, legacy).

sortsobject[] nullable

Sort criteria as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort.

searchstring nullable

Search term for wildcard search across namespace_id, namespace_name, description, and other text fields.

case_sensitiveboolean

If True, filters and search will be case-sensitive

Example request

{
  "filters": {
    "namespace_id": "ns_abc123"
  },
  "sort": {
    "direction": "asc",
    "field": "namespace_name"
  }
}

Response

Successful Response

total_countinteger required

Total number of namespaces that match the query

Example response

{
  "pagination": {
    "has_more": false,
    "limit": 10,
    "skip": 0
  },
  "results": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "description": "This namespace contains playlists from Spotify",
      "feature_extractors": [
        {
          "feature_extractor_name": "multimodal_extractor",
          "version": "v1"
        },
        {
          "feature_extractor_name": "image_extractor",
          "params": {
            "model": "siglip_base"
          },
          "version": "v1"
        }
      ],
      "namespace_id": "ns_ab12cd34ef",
      "namespace_name": "spotify_playlists_dev",
      "payload_indexes": [
        {
          "field_name": "metadata.title",
          "type": "text"
        }
      ],
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total_count": 1
}