Skip to content

client.graph

Generated methods for the graph namespace. Sync owner: WarmHubClient.graph. Async owner: AsyncWarmHubClient.graph.

archive(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.archive — mutate graph.archive.

create(org_name: str, graph_name: str, description: str | Unset = UNSET, visibility: Literal['public', 'private'] | Unset = UNSET, display_name: str | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.create — mutate graph.create.

delete(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

graph.delete — mutate graph.delete. Soft-delete a graph.

The graph is hidden immediately and scheduled for permanent purge after a 30-day grace window. The backend refuses the delete while another graph still has inbound cross-graph references, active subscriptions, or active credential grants depending on this one.

grace_expires_at on the result is the epoch-millisecond int the server sent, not a datetime.

describe(org_name: str, graph_name: str, *, include_head: bool | Unset = UNSET, include_indexed_fields: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphDescribeResult

graph.describe — query graph.describe.

explore(*, search: str | Unset = UNSET, org: str | Unset = UNSET, activity: Literal['week', 'month'] | Unset = UNSET, has_subscriptions: Literal[True] | Unset = UNSET, min_things: float | Unset = UNSET, sort: Literal['recentlyUpdated', 'mostSubscribed', 'mostThings', 'nameAsc', 'newest'] | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, slugs: Sequence[str] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphExploreResult

graph.explore — query graph.explore.

explore_iter(*, search: str | Unset = UNSET, org: str | Unset = UNSET, activity: Literal['week', 'month'] | Unset = UNSET, has_subscriptions: Literal[True] | Unset = UNSET, min_things: float | Unset = UNSET, sort: GraphExploreSort | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, slugs: Sequence[str] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every public Explore browse result, page by page. No auth required.

slugs mode is not pageable and raises VALIDATION_ERROR before any request — the guard runs in the factory, not inside the iterator.

total and the orgs facet are first-page-only fields on the underlying result; iterating yields items, so neither is observable here. Call explore directly when you need them.

get(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.get — query graph.get.

get_agents(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> WireThingDetail

graph.getAgents — query graph.getAgents.

get_configure_stats(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphConfigureStats

graph.getConfigureStats — query graph.configureStats.

get_license(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphLicense | None

graph.getLicense — query graph.getLicense.

get_llms_txt(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SynthesizedGraphContent

graph.getLlmsTxt — query graph.getLlmsTxt.

get_readme(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> WireThingDetail

graph.getReadme — query graph.getReadme.

get_shape_instance_counts(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> JsonValue

graph.getShapeInstanceCounts — query graph.shapeInstanceCounts.

get_stats(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphStats

graph.getStats — query graph.stats.

get_stats_batch(org_name: str, graph_names: Sequence[str], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphStatsBatchResult

graph.getStatsBatch — query graph.statsBatch.

list(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: Literal['newest', 'oldest', 'nameAsc', 'nameDesc'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphListResult

graph.list — query graph.list.

list_for_caller(*, limit: float | Unset = UNSET, sort: Literal['recent', 'name'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[GraphForCaller, ...]

graph.listForCaller — query graph.listForCaller.

list_iter(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: GraphListSort | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every graph in the org, page by page. for graph in ....

list_page(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: Literal['newest', 'oldest', 'nameAsc', 'nameDesc'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphListPageResult

graph.listPage — query graph.listPage.

list_page_iter(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: GraphListSort | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every graph row with stats, page by page.

The dashboard-oriented twin of list_iter: same filters, rows carrying exact active counts, last_write_at and has_errors.

rename(org_name: str, graph_name: str, new_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.rename — mutate graph.rename.

search(query: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GlobalSearchResult

graph.search — query graph.search.

search_iter(query: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every global graph search hit, page by page.

Searches across all orgs: public graphs plus private ones the caller can read.

set_agents(org_name: str, graph_name: str, content: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CommitApplyCompatibilityResult

graph.setAgents — mutate graph.setAgents.

set_description(org_name: str, graph_name: str, description: str | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.setDescription — mutate graph.setDescription.

set_display_name(org_name: str, graph_name: str, display_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.setDisplayName — mutate graph.setDisplayName.

set_readme(org_name: str, graph_name: str, content: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CommitApplyCompatibilityResult

graph.setReadme — mutate graph.setReadme.

set_visibility(org_name: str, graph_name: str, visibility: Literal['public', 'private'], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.setVisibility — mutate graph.setVisibility.

unarchive(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.unarchive — mutate graph.unarchive.

update(*, org_name: str, graph_name: str, display_name: str | Unset = UNSET, new_name: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.update — mutate graph.update.

archive(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.archive — mutate graph.archive.

create(org_name: str, graph_name: str, description: str | Unset = UNSET, visibility: Literal['public', 'private'] | Unset = UNSET, display_name: str | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.create — mutate graph.create.

delete(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

graph.delete — mutate graph.delete. Soft-delete a graph.

The graph is hidden immediately and scheduled for permanent purge after a 30-day grace window. The backend refuses the delete while another graph still has inbound cross-graph references, active subscriptions, or active credential grants depending on this one.

grace_expires_at on the result is the epoch-millisecond int the server sent, not a datetime. See the module docstring: TypeScript’s new Date(...) wrap is a JS-side ergonomic, and every timestamp in this package is wire-typed.

describe(org_name: str, graph_name: str, *, include_head: bool | Unset = UNSET, include_indexed_fields: bool | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphDescribeResult

graph.describe — query graph.describe.

explore(*, search: str | Unset = UNSET, org: str | Unset = UNSET, activity: Literal['week', 'month'] | Unset = UNSET, has_subscriptions: Literal[True] | Unset = UNSET, min_things: float | Unset = UNSET, sort: Literal['recentlyUpdated', 'mostSubscribed', 'mostThings', 'nameAsc', 'newest'] | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, slugs: Sequence[str] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphExploreResult

graph.explore — query graph.explore.

explore_iter(*, search: str | Unset = UNSET, org: str | Unset = UNSET, activity: Literal['week', 'month'] | Unset = UNSET, has_subscriptions: Literal[True] | Unset = UNSET, min_things: float | Unset = UNSET, sort: GraphExploreSort | Unset = UNSET, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, slugs: Sequence[str] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every public Explore browse result, page by page. No auth required.

slugs mode is not pageable and raises VALIDATION_ERROR before any request — the guard runs in the factory, not inside the iterator, so it fires on the call that named slugs rather than on whichever page a caller happens to pull first.

total and the orgs facet are first-page-only fields on the underlying result; iterating yields items, so neither is observable here. Call explore directly when you need them.

get(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.get — query graph.get.

get_agents(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> WireThingDetail

graph.getAgents — query graph.getAgents.

get_configure_stats(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphConfigureStats

graph.getConfigureStats — query graph.configureStats.

get_license(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphLicense | None

graph.getLicense — query graph.getLicense.

get_llms_txt(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SynthesizedGraphContent

graph.getLlmsTxt — query graph.getLlmsTxt.

get_readme(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> WireThingDetail

graph.getReadme — query graph.getReadme.

get_shape_instance_counts(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> JsonValue

graph.getShapeInstanceCounts — query graph.shapeInstanceCounts.

get_stats(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphStats

graph.getStats — query graph.stats.

get_stats_batch(org_name: str, graph_names: Sequence[str], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphStatsBatchResult

graph.getStatsBatch — query graph.statsBatch.

list(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: Literal['newest', 'oldest', 'nameAsc', 'nameDesc'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphListResult

graph.list — query graph.list.

list_for_caller(*, limit: float | Unset = UNSET, sort: Literal['recent', 'name'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[GraphForCaller, ...]

graph.listForCaller — query graph.listForCaller.

list_iter(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: GraphListSort | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every graph in the org, page by page. async for graph in ....

list_page(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: Literal['newest', 'oldest', 'nameAsc', 'nameDesc'] | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphListPageResult

graph.listPage — query graph.listPage.

list_page_iter(org_name: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, include_archived: bool | Unset = UNSET, search: str | Unset = UNSET, sort: GraphListSort | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every graph row with stats, page by page.

The dashboard-oriented twin of list_iter: same filters, rows carrying exact active counts, last_write_at and has_errors.

rename(org_name: str, graph_name: str, new_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.rename — mutate graph.rename.

search(query: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GlobalSearchResult

graph.search — query graph.search.

search_iter(query: str, *, limit: float | Unset = UNSET, cursor: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET)

Every global graph search hit, page by page.

Searches across all orgs: public graphs plus private ones the caller can read.

set_agents(org_name: str, graph_name: str, content: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CommitApplyCompatibilityResult

graph.setAgents — mutate graph.setAgents.

set_description(org_name: str, graph_name: str, description: str | Unset = UNSET, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.setDescription — mutate graph.setDescription.

set_display_name(org_name: str, graph_name: str, display_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.setDisplayName — mutate graph.setDisplayName.

set_readme(org_name: str, graph_name: str, content: str, *, event_request_id: str, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> CommitApplyCompatibilityResult

graph.setReadme — mutate graph.setReadme.

set_visibility(org_name: str, graph_name: str, visibility: Literal['public', 'private'], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.setVisibility — mutate graph.setVisibility.

unarchive(org_name: str, graph_name: str, *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.unarchive — mutate graph.unarchive.

update(*, org_name: str, graph_name: str, display_name: str | Unset = UNSET, new_name: str | Unset = UNSET, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> GraphInfo

graph.update — mutate graph.update.