Skip to main content

namespaces.list

Retrieves a list of all namespaces accessible by your API key. Returns: Dict[str, Any] - A dictionary containing a list of namespace objects under the namespaces key. Raises: AuthenticationError, APIError.

Example

List Namespaces Example

Response Structure

The response contains a namespaces array with the following fields for each namespace:
  • namespace_name (str): Unique name of the namespace
  • type (str): Namespace type: “text” or “vector”
  • vector_dimension (int | None): Vector dimension (null for text namespaces)
  • item_count (int): Total number of items in the namespace
  • created_at (str): ISO 8601 timestamp of creation

Complete Example

Complete Example

Use Cases

  • Dashboard Display: Show namespace overview with usage statistics
  • Data Management: Monitor storage usage and document counts
  • Namespace Selection: Populate dropdowns for namespace selection in applications
  • Usage Analytics: Track namespace growth and activity over time
  • Resource Planning: Understand storage and document distribution across namespaces