Skip to main content
POST

Authorizations

Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Headers

X-Pinecone-Api-Version
string
default:2025-10
required

Required date-based version header

Body

application/json

A request for creating a namespace with the specified namespace name.

name
string
required

The name of the namespace.

Example:

"example-namespace"

schema
object

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when schema is present, only fields which are present in the fields object with a filterable: true are indexed. Note that filterable: false is not currently supported.

Example:

Response

A successful response.

A description of a namespace, including the name and record count.

name
string

The name of the namespace.

Example:

"example-namespace"

record_count
integer<int64>

The total amount of records within the namespace.

Example:

20000

schema
object

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when schema is present, only fields which are present in the fields object with a filterable: true are indexed. Note that filterable: false is not currently supported.

Example:
indexed_fields
object

A list of all indexed metatadata fields in the namespace