Context

ContextResource

class ContextResource(http: HttpClient, config: ModusConfig)

Bases: object Full knowledge base access for modus.management.ModusManagement. mgmt.context.items.list() → Page[ContextItem] mgmt.context.items.get(uid) → ContextItem mgmt.context.items.update(uid, …) → ContextItem mgmt.context.items.delete(uid) → ContextItemDeletion mgmt.context.create_note(title, content) → CreatedContextItem mgmt.context.update_note(uid, title=…, body=…) → ContextItem mgmt.context.create_saved_query(name, query, …) → CreatedContextItem mgmt.context.update_saved_query(uid, name=…, …) → ContextItem mgmt.context.create_link(url, …) → CreatedContextItem mgmt.context.update_link(uid, title=…, url=…) → ContextItem

create_note()

create_note(title: str, content: str) → CreatedContextItem

Add a free-form text note to the Modus knowledge base.

Parameters:
- title – Display title for the note.
- content – Markdown body text.
Returns: Created item with its new uid.

update_note()

update_note(uid: str, *, title: str, body: str, existing: ContextItemDto | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None) → ContextItemDto

Update a note’s title and markdown body. Preserves server-owned fields (noteId, s3Key, …) on the existing content blob. Pass existing to skip a GET when you already have the item from a list call.

create_saved_query()

create_saved_query(name: str, query: str | None = None, *, connection_id: str, description: str | None = None, path: List[str] | None = None) → CreatedContextItem

Save a SQL query to the Modus knowledge base.

Parameters:
- name – Display name for the saved query.
- query – SQL text (optional at create if you set it later).
- connection_id – Data connection the query runs against.
- description – Optional human-readable description.
- path – Optional hierarchical path segments for organisation.
Returns: Created item with its new uid.

update_saved_query()

update_saved_query(uid: str, *, name: str, query: str, connection_id: str | None = None, path: List[str] | None = None, existing: ContextItemDto | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None) → ContextItemDto

Update a saved query’s name, SQL, and optional connection metadata.

create_link()

create_link(url: str, *, title: str | None = None, is_crawl: bool | None = None, page_limit: int | None = None) → CreatedContextItem

Add a URL to the Modus knowledge base.

Parameters:
- url – Link target URL.
- title – Optional display title.
- is_crawl – When True, fetch and index page content.
- page_limit – Maximum pages to crawl when is_crawl is True.
Returns: Created item with its new uid.

update_link()

update_link(uid: str, *, title: str | None = None, url: str | None = None, existing: ContextItemDto | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None) → ContextItemDto

Update link metadata on an existing item. Merges title and/or url into the stored content blob. Does not re-fetch or re-crawl the URL.

AsyncContextResource

class AsyncContextResource(http: AsyncHttpClient, config: ModusConfig)

Bases: object

create_note()

async create_note(title: str, content: str) → CreatedContextItem

Add a free-form text note to the Modus knowledge base.

update_note()

async update_note(uid: str, *, title: str, body: str, existing: ContextItemDto | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None) → ContextItemDto

Update a note’s title and markdown body.

create_saved_query()

async create_saved_query(name: str, query: str | None = None, *, connection_id: str, description: str | None = None, path: List[str] | None = None) → CreatedContextItem

Save a SQL query to the Modus knowledge base. See the sync create_saved_query for argument details.

update_saved_query()

async update_saved_query(uid: str, *, name: str, query: str, connection_id: str | None = None, path: List[str] | None = None, existing: ContextItemDto | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None) → ContextItemDto

Update a saved query’s name, SQL, and optional connection metadata.

create_link()

async create_link(url: str, *, title: str | None = None, is_crawl: bool | None = None, page_limit: int | None = None) → CreatedContextItem

Add a URL to the Modus knowledge base. See the sync create_link for argument details.

update_link()

async update_link(uid: str, *, title: str | None = None, url: str | None = None, existing: ContextItemDto | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None) → ContextItemDto

Update link metadata on an existing item.

ContextItemsResource

class ContextItemsResource(http: HttpClient, config: ModusConfig)

Bases: object

list()

list(*, page_size: int = 25, page_token: str | None = None, context_type: str | None = None) → Page[ContextItemDto]

List context items in the knowledge base.

Parameters:
- page_size – Items per page (default 25).
- page_token – Opaque token from a previous page’s next_page_token.
- context_type – Filter by type, e.g. "note", "link", "saved_query".
Returns: Page of context items.

get()

get(uid: str) → ContextItemDto

Retrieve a context item by its UID.

Parameters: uid – The item’s UUID.
Returns: The context item.
Raises: NotFoundError – if no item with this UID exists.

update()

update(uid: str, *, content: Any | None = None, context_type: str | None = None, description: str | None = None, user_feedback: UserFeedback | str | None = None, topics: List[str] | None = None, update_mask: str | None = None) → ContextItemDto

Update a context item.

Parameters:
- uid – UUID of the context item to update.
- content – Replacement type-specific content, if changing it.
- context_type – The item’s type (e.g. "note"). Required when content is supplied.
- description – New description, if changing it.
- user_feedback – Feedback verdict — "positive", "neutral", or "negative".
- topics – Replacement topic tags. Pass [] to clear all tags.
- update_mask – Comma-separated field names to clear. Name a field here and leave its argument unset to set it to null on the server; fields not named in the mask are left untouched.

Only the fields you pass are changed; omitted fields are left as-is.

delete()

delete(uid: str) → DeleteContextItemResponseDto

Delete a context item from the knowledge base.

Parameters: uid – The item’s UUID.
Returns: Deletion confirmation with the removed item’s UID.

CustomContextItemsResource

class CustomContextItemsResource(http: HttpClient, config: ModusConfig)

Bases: object

list()

list(*, page_size: int = 25, page_token: str | None = None, search_query: str | None = None, topics: List[str] | None = None) → Page[ContextItemDto]

List custom context items in the organization.

Parameters:
- page_size – Maximum items per page.
- page_token – Cursor from a previous page.
- search_query – Optional free-text filter.
- topics – Optional topic filters.
Returns: A page of custom context items.

get()

get(uid: str) → ContextItemDto

Fetch one custom context item by uid.

Parameters: uid – Custom context item identifier.
Returns: The matching custom context item.

create()

create(**payload: Any) → Dict[str, Any]

Create a custom context item for an internal system or custom database.

batch_create()

batch_create(items: List[Dict[str, Any]]) → List[Dict[str, Any]]

Create or update a batch of custom context items by stable hierarchy.

update()

update(uid: str, **payload: Any) → Dict[str, Any]

Update mutable fields on a custom context item.

Parameters:
- uid – Custom context item identifier.
- **payload – Fields to update, such as description or topics.
Returns: The update acknowledgement payload.

delete()

delete(uid: str) → DeleteContextItemResponseDto

Delete a custom context item.

Parameters: uid – Custom context item identifier.
Returns: Deletion metadata for the removed item.

Types

Errors

Getting Started

API Reference

ContextResource

create_note()

update_note()

create_saved_query()

update_saved_query()

create_link()

update_link()

AsyncContextResource

create_note()

update_note()

create_saved_query()

update_saved_query()

create_link()

update_link()

ContextItemsResource

list()

get()

update()

delete()

CustomContextItemsResource

list()

get()

create()

batch_create()

update()

delete()

​ContextResource

​create_note()

​update_note()

​create_saved_query()

​update_saved_query()

​create_link()

​update_link()

​AsyncContextResource

​create_note()

​update_note()

​create_saved_query()

​update_saved_query()

​create_link()

​update_link()

​ContextItemsResource

​list()

​get()

​update()

​delete()

​CustomContextItemsResource

​list()

​get()

​create()

​batch_create()

​update()

​delete()

ContextResource

create_note()

update_note()

create_saved_query()

update_saved_query()

create_link()

update_link()

AsyncContextResource

create_note()

update_note()

create_saved_query()

update_saved_query()

create_link()

update_link()

ContextItemsResource

list()

get()

update()

delete()

CustomContextItemsResource

list()

get()

create()

batch_create()

update()

delete()