v1

latestOpenAPI 3.0.3Apache 2.02026-07-1372170520.1 KB

Namespace Operations

Describe a namespace

Describe a namespace in a serverless index, including the total number of vectors in the namespace.

For guidance and examples, see Manage namespaces.

Note: This operation is not supported for pod-based indexes.

get/namespaces/{namespace}

Path parameters

namespacestring required

The namespace to describe.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

A description of a namespace.

namestring

The name of the namespace.

record_countinteger

The total amount of records within the namespace.

Example response

{
  "name": "example-namespace",
  "record_count": 20000,
  "schema": {
    "fields": {
      "description": {
        "filterable": true
      },
      "genre": {
        "filterable": true
      },
      "year": {
        "filterable": true
      }
    }
  },
  "indexed_fields": {
    "fields": [
      "genre",
      "year",
      "author"
    ]
  }
}