ResearchClient

synth_ai.research.client

SynthClient().research namespace (alpha).

Classes

ResearchClient

Managed Research entrypoint on SynthClient.

SMR (Managed Research) is the product umbrella; its capabilities are Managed Factories (factories) and Managed Swarms (swarms) — swarms launch directly or are composed by factories. Namespaces also cover projects, limits, economics, secrets, and Factory Tag (factories.tag).

Methods:

session

session(self) -> ManagedResearchClient

Low-level session client (advanced integrations and eval harnesses only).

Prefer hero namespaces (projects, swarms, limits) for new code.

backing_client

backing_client(self) -> ManagedResearchClient

Deprecated alias for :attr:session.

factories

factories(self) -> ResearchFactoriesAPI

Factory domain APIs (Tag at factories.tag).

efforts

efforts(self) -> ResearchEffortsAPI

Graduate runs into persistent Efforts (efforts.proposals for proposals).

projects

projects(self) -> ResearchProjectsAPI

Create and configure Managed Research projects.

swarms

swarms(self) -> ResearchSwarmsAPI

Launch Managed Swarms and open swarm-scoped readout handles.

runs

runs(self) -> ResearchSwarmsAPI

Deprecated alias for :attr:swarms (the public noun is Swarm).

limits

limits(self) -> ResearchLimitsAPI

Read org limits and allowance before launching work.

economics

economics(self) -> ResearchEconomicsAPI

Read authoritative org entitlements and project economics.

secrets

secrets(self) -> ResearchSecretsAPI

Manage project secret refs for providers and repos.

hosted_artifacts

hosted_artifacts(self) -> ResearchHostedArtifactsAPI

Open Research hosted artifact operator API (read, promote, review).

visuals

visuals(self) -> ResearchVisualsAPI

Publish and browse first-class blob-backed Synth Visuals.

experiments

experiments(self) -> ResearchExperimentsAPI

Typed experiment bundles, history, and comparisons.

knowledge

knowledge(self) -> ResearchKnowledgeAPI

Org-level durable knowledge document.

wiki

wiki(self) -> ResearchWikiAPI

Project wiki reads plus proposal intake.

account

account(self) -> ResearchAccountAPI

Org account: balance, credits, usage, BYOK, members, identity.

tag

tag(self) -> TagAPI

Deprecated — use factories.tag instead.

get_limits

get_limits(self) -> dict[str, Any]

Return the legacy raw payload; use typed limits.get_typed() instead.

close

close(self) -> None

Close the underlying HTTP session and cached namespace clients.