Count vector records

Count records in a vector namespace, with an optional metadata filter. Counts are exact.

POST /v1/tenants/{tenant}/vector-indexes/{index}/records/count

Count the records matching your filterCounts are exact; an over-budget request fails instead of estimating.

Choose the namespaceOptionally supply one metadata filter.
Evaluate matching recordsCount records within that namespace.
Read the countUse the returned number for the selected scope.

Before you start

Use your database bearer token.

Use the target vector index and, where required, its namespace. The examples use index demo-search and namespace demo.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`index`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Request body

application/json

Limits and accepted values

filter_expr is the native filter expression and filter the legacy metadata filter;
send at most one.
An empty filter counts every record.
Counts are never approximate: a filtered count over its budget is refused (413/422).

Field	Type	Required
`filter`	`object`	Optional
`filter_expr`	`object`	Optional
`namespace`	`string`	Required

Read the result

count is the exact number of records matching the namespace and optional filter. A rejected over-budget count is an error, not an approximate answer.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/vector-indexes/demo-search/records/count" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "namespace": "demo"
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "namespace": "demo",
  "count": 2
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link