API Reference

Vector Stores

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Vectors

List Vectors

vector_stores.vectors.list(strvector_store_name, VectorListParams**kwargs) -> SyncCursorPageVectors[VectorDocument]

GET/v5/vector-stores/{vector_store_name}/vectors

Get Vector

vector_stores.vectors.retrieve(strvector_id, VectorRetrieveParams**kwargs) -> VectorDocument

GET/v5/vector-stores/{vector_store_name}/vectors/{vector_id}

ModelsExpand Collapse

class VectorDocument: …

A document returned from direct lookups (get/list operations).

id: str

Document ID

content: Optional[TextContent]

Text content for documents.

text: str

Text content to be embedded

type: Optional[Literal["text"]]

Content type identifier

metadata: Optional[Dict[str, object]]

Key-value metadata

vector: Optional[List[float]]

Embedding vector (if requested)