Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt

Use this file to discover all available pages before exploring further.

If you have added items to the index with the item field, you can retrieve them via get().
The contents field is always returned as bytes in Python or std::vector<uint8_t> in C++, regardless of whether it was originally stored as a string or bytes. All contents are encoded to bytes and encrypted before storage.
# IDs of items to retrieve
ids = ["item_20", "item_11"]
include = ["contents", "metadata"]

# Retrieve items from the encrypted index
items = index.get(ids, include)

print(items)
# Example item (contents returned as bytes)
# [{"id": "item_20", "contents": b"Hello, World!", "metadata": {"type": "txt"}},
#  {"id": "item_11", "contents": b"Hello, Cyborg!", "metadata": {"type": "md"}}]

API Reference

For more information on getting items from an encrypted index, refer to the API reference:

Python API Reference

API reference for get() in Python

C++ API Reference

API reference for Get() in C++