How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

turbopuffer Namespaces API

The Namespaces API from turbopuffer — 12 operation(s) for namespaces.

turbopuffer Namespaces API is one of 11 APIs that turbopuffer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Namespaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 14 operations across 12 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against a single base URL, https://{region}.turbopuffer.com.

14 operations 12 paths 44 schemas 1 DELETE4 GET1 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://api.turbopuffer.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

turbopuffer Namespaces API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API key) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 4 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Namespaces 14
GET
/v1/namespaces
List namespaces.
3 params → 200default
GET
/v1/namespaces/{namespace}/schema
Get namespace schema.
1 param → 200default
POST
/v1/namespaces/{namespace}/schema
Update namespace schema.
1 param body → 200default
GET
/v2/namespaces/{namespace}/metadata
Get metadata about a namespace.
1 param → 200default
PATCH
/v1/namespaces/{namespace}/metadata
Update metadata configuration for a namespace.
1 param body → 200default
GET
/v1/namespaces/{namespace}/hint_cache_warm
Signal turbopuffer to prepare for low-latency requests.
1 param → 202default
POST
/v1/namespaces/{namespace}/_debug/recall
Evaluate recall.
1 param body → 200default
POST
/v2/namespaces/{namespace}
Create, update, or delete documents.
1 param body → 200default
DELETE
/v2/namespaces/{namespace}
Delete namespace.
1 param → 200default
POST
/v2/namespaces/{namespace}/query
Query, filter, full-text search and vector search documents.
1 param body → 200default
POST
/v2/namespaces/{namespace}/query?stainless_overload=multiQuery
Issue multiple concurrent queries filter or search documents.
1 param body → 200default
POST
/v2/namespaces/{namespace}?stainless_overload=branchFrom
Creates an instant, copy-on-write clone of a namespace.
1 param body → 200default
POST
/v2/namespaces/{namespace}?stainless_overload=copyFrom
Copy all documents from another namespace into this one.
1 param body → 200default
POST
/v2/namespaces/{namespace}/explain_query
Explain a query plan.
1 param body → 200default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Write (19 properties), WriteResult (12 properties), Query (9 properties), FullTextSearchConfig (9 properties). Each schema is shown below with its type and property counts.

Limit
object
Limits the documents returned by a query.
2 properties 1 required
PatchByFilter
object
The patch and filter specifying which documents to patch.
2 properties 2 required
CopyFromNamespaceParams
Tokenizer
The tokenizer to use for full-text search on an attribute. Defaults to wordv3.
Columns
object
A list of documents in columnar format. Each key is a column name, mapped to an array of values for that column.
2 properties 1 required
DistanceMetric
A function used to calculate vector similarity.
AttributeSchema
The schema for an attribute attached to a document.
Row
object
A single document, in a row-based format.
2 properties 1 required
Query
object
Query, filter, full-text search and vector search documents.
9 properties
NamespaceMetadata
object
Metadata about a namespace.
8 properties 7 required
BranchFromNamespaceParams
Vector
A vector embedding associated with a document.
AggregationGroup
object
A single aggregation group.
FullTextSearch
Whether this attribute can be used as part of a BM25 full-text search. Requires the string or []string type, and by default, BM25-enabled attributes are not fi…
IncludeAttributes
Whether to include attributes in the response.
SparseDistanceMetric
A function used to calculate sparse vector similarity.
VectorEncoding
The encoding to use for vectors in the response.
Language
Describes the language of a text attribute. Defaults to english.
Write
object
Create, update, or delete documents.
19 properties
PinningConfigResponse
Configuration for namespace pinning, along with the current status of the pinned namespace.
Encryption
The encryption configuration for a namespace.
Ann
Whether to create an approximate nearest neighbor index for the attribute. Can be a boolean or a detailed configuration object.
QueryResult
object
The result of a query.
AttributeType
string
The data type of the attribute. Valid values: string, int, uint, float, uuid, datetime, bool, []string, []int, []uint, []float, []uuid, []datetime, []bool, [DI…
ErrorResponse
object
The response to an unsuccessful request.
2 properties 2 required
NamespaceSummary
object
A summary of a namespace.
1 property 1 required
CopyFromNamespaceConfig
object
3 properties 1 required
PinningConfig
object
Configuration for namespace pinning.
1 property
QueryPerformance
object
The performance information for a query.
6 properties 6 required
QueryConfig
object
Configuration options for a query.
2 properties
AnnConfig
object
Configuration options for ANN (Approximate Nearest Neighbor) indexing.
1 property
Id
An identifier for a document.
WritePerformance
object
The performance information for a write request.
1 property 1 required
FullTextSearchConfig
object
Configuration options for full-text search.
9 properties
MultiQueryResult
object
The result of a multi-query.
3 properties 3 required
WriteResult
object
The response to a successful write request.
12 properties 4 required
PinningStatus
object
Operational status for a pinned namespace.
3 properties 3 required
WriteBilling
object
The billing information for a write request.
2 properties 1 required
AttributeSchemaConfig
object
Detailed configuration for an attribute attached to a document.
8 properties 1 required
QueryBilling
object
The billing information for a query.
2 properties 2 required
SingleQueryResult
object
3 properties
NamespaceMetadataPatch
object
Request to update namespace metadata configuration.
1 property
BranchFromNamespaceConfig
object
1 property 1 required
SparseKnn
object
Whether to create a sparse kNN index for the attribute. Requires the {}f16 type.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

turbopuffer-namespaces-api-openapi.yml Raw ↑

Other APIs turbopuffer publishes across the network.

turbopuffer Write API
turbopuffer Query API
turbopuffer Namespaces API
turbopuffer Python SDK
turbopuffer TypeScript SDK
turbopuffer Go SDK
turbopuffer Java SDK
turbopuffer Ruby SDK
turbopuffer C# SDK
tpuf-benchmark
Where this information came from

This is an independent, third-party profile of turbopuffer Namespaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.