Search + K

Command Palette

Search for a command to run...

Sign In

Get Vectors By Identifier (Deprecated)

Deprecated
POST /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids
Copy endpoint
https://api.cloudflare.com/client/v4

Get a set of vectors from an index by their vector identifiers.

Parameters

path Path Parameters

Name Type
account_id required
type VectorizeIdentifier = string
index_name required
type VectorizeIndexName = string

Request Body

application/json required
interface VectorizeIndexGetVectorsByIdRequest {
ids?: VectorizeVectorIdentifier

Identifier for a Vector

type VectorizeVectorIdentifier = string
[]
;
}

Responses

200 application/json

Get Vectors By Identifier Response

type VectorizeApiResponseSingle = never & { result?: VectorizeIndexGetVectorsByIdResponse

Array of vectors with matching ids.

type VectorizeIndexGetVectorsByIdResponse = {
id?: VectorizeVectorIdentifier;
metadata?: {};
namespace?: string | null;
values?: number[];
}
[]
; }

Client Errors

4XX application/json

Get Vectors By Identifier Failure Response

type VectorizeApiResponseSingle = never & { result?: {} | null; } & interface VectorizeApiResponseCommonFailure {
errors: VectorizeMessages
type VectorizeMessages = { code: number;message: string; }[]
;
messages: VectorizeMessages
type VectorizeMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}