Cloudflare Vectorize icon

Cloudflare Vectorize

Execute operations against Cloudflare Vectorize vector databases. Supports vector operations (insert, upsert, query), index management, metadata filtering, and can be used as a tool by AI Agents for semantic search and RAG applications.

Utility → List Vectors

AI-generated

Overview

The "List Vectors" operation under the "Utility" resource in this node allows users to retrieve a paginated list of vector IDs from a specified vector index managed by Cloudflare Vectorize. This is useful for administrative and debugging purposes, such as auditing which vectors exist in an index or managing large datasets by fetching vector IDs in chunks.

Typical use cases include:

  • Inspecting the contents of a vector index.
  • Implementing pagination in custom workflows that process vectors in batches.
  • Debugging or monitoring vector data stored in Cloudflare Vectorize indexes.

For example, you might want to list up to 500 vector IDs starting from a specific cursor position to process them in your workflow or to verify the vectors currently stored in an index.

Properties

Name Meaning
Index Name The name of the Vectorize index to list vectors from. Must be lowercase and contain only letters, numbers, and hyphens.
Limit Maximum number of vector IDs to return in one call. Accepts values between 1 and 1000.
Cursor Pagination cursor string from a previous response to continue listing vectors from that point.

Output

The output JSON contains the following fields:

  • vectors: An array of vector ID strings representing the vectors listed from the index.
  • count: Number of vector IDs returned in this response.
  • totalCount: Total number of vectors available in the index.
  • isTruncated: Boolean indicating if there are more vectors to fetch beyond this response.
  • cursor: A string cursor token to be used in subsequent requests to continue listing vectors from where the last call ended.

This structure supports efficient pagination through large sets of vectors.

Dependencies

  • Requires an active connection to Cloudflare Vectorize service with appropriate API authentication configured in n8n credentials.
  • The node depends on utility functions from a bundled helper module that handles API communication and formatting.

Troubleshooting

  • Invalid Index Name: Ensure the index name is lowercase and contains only letters, numbers, and hyphens. Invalid names will cause errors.
  • Limit Out of Range: The limit must be between 1 and 1000. Setting a value outside this range may result in an error or unexpected behavior.
  • Invalid Cursor: Using an expired or malformed cursor string can cause pagination failures. Always use the cursor returned from the previous successful response.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has permissions to access the specified index.
  • Network Issues: Connectivity problems with the Cloudflare Vectorize API endpoint will cause request failures.

If the node throws an error mentioning unknown utility operations or resources, check that the correct resource ("utility") and operation ("listVectors") are selected.

Links and References

Discussion