Fetch records by filter

POST /v1/tenants/{tenant}/vector-indexes/{index}/records/fetch-by-filter

Read matching vector records in pagesPages use read-committed data rather than one frozen snapshot.

Set the metadata filterSelect the namespace and desired record fields.
Read the current pageInspect returned records keyed by ID.
Follow the returned cursorContinue with the same namespace and filter.

Before you start

Use your database bearer token.

Choose exactly one nonempty filter. Results contain the current committed records.

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

Exactly one of filter_expr or filter is required and it must not be empty.
limit 1-10,000, default 100.
Projection fields as for fetch.
consistency: read_committed (default);
snapshot is refused with 400.

Field	Type	Required
`consistency`	`string`	Optional
`cursor`	`string`	Optional
`filter`	`object`	Optional
`filter_expr`	`object`	Optional
`include_metadata`	`boolean`	Optional
`include_sparse`	`boolean`	Optional
`include_values`	`boolean`	Optional
`limit`	`integer`	Optional
`metadata_fields`	`string[]`	Optional

Fields in metadata_fields

Field	Type	Required
`metadata_fields`	`string`	Optional

Field	Type	Required
`namespace`	`string`	Required
`text_fields`	`string[]`	Optional

Fields in text_fields

Field	Type	Required
`text_fields`	`string`	Optional

Read the result

records contains the current page of matching records, keyed by ID. Follow a returned cursor to continue. This is a read-committed view, not a frozen snapshot across pages.

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.
409	Resolve the conflict before retrying.
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/fetch-by-filter" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "namespace": "demo",
  "filter": {
    "category": "outdoor"
  },
  "limit": 10,
  "include_metadata": true
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "namespace": "demo",
  "records": {
    "v1": {
      "id": "v1",
      "rev": 1,
      "revision_token": "<opaque-revision-token-for-v1>",
      "updated_at": "2026-10-30T00:00:00.000Z",
      "metadata": {
        "category": "outdoor"
      }
    }
  }
}

Before the update fixture changes v1.category to camping; only outdoor records match.

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