Projects

synth_ai.research.projects

client.research.projects — alpha project surface.

Classes

ResearchProjectsAPI

Public Research project methods (alpha must-have).

Nested namespaces: setup, workspace, repos, git, objectives, milestones, and project-scoped runs.

Methods:

setup

setup(self) -> ResearchProjectsSetupAPI

Onboarding and runnable-project preparation.

workspace

workspace(self) -> ResearchProjectsWorkspaceAPI

Upload, download, and inspect project workspace inputs.

repos

repos(self) -> ResearchProjectsReposAPI

Attach source repositories to project workspace inputs.

git

git(self) -> ResearchProjectsGitAPI

Project git source connection and metadata.

code

code(self) -> ResearchProjectsCodeAPI

Download project code archives.

objectives

objectives(self) -> ResearchProjectsObjectivesAPI

Directed effort outcomes and objective status.

milestones

milestones(self) -> ResearchProjectsMilestonesAPI

Project and run-scoped milestones.

runs

runs(self) -> ResearchProjectsRunsAPI

List runs belonging to a project.

notes

notes(self) -> ResearchProjectsNotesAPI

Durable free-form project notes.

create

create(self, request: SmrRunnableProjectRequest | Mapping[str, Any] | dict[str, Any]) -> ResearchCreateProjectResult

Create a runnable Managed Research project.

Args:

• request: SmrRunnableProjectRequest or wire-compatible mapping (requires at least name and work_mode).

Returns:

• ResearchCreateProjectResult with project_id for setup/launch.

create_runnable

create_runnable(self, request: SmrRunnableProjectRequest | Mapping[str, Any] | dict[str, Any]) -> ResearchCreateProjectResult

Create a runnable project (alias used internally by create).

list

list(self) -> List[ResearchProject]

List projects visible to the authenticated org.

get

get(self, project_id: str) -> ResearchProject

Fetch a single project by id.

update

update(self, project_id: str, payload: Mapping[str, Any] | dict[str, Any], **kwargs: Any) -> dict[str, Any]

Patch project fields (name, work mode, metadata, etc.).

archive

archive(self, project_id: str) -> dict[str, Any]

Archive a project (hidden from default list).

unarchive

unarchive(self, project_id: str) -> dict[str, Any]

Restore an archived project.

setup_state

setup_state(self, project_id: str) -> SmrProjectSetup

Deprecated alias for setup.get.

prepare_setup

prepare_setup(self, project_id: str) -> SmrProjectSetup

Deprecated alias for setup.prepare.

start_onboarding

start_onboarding(self, project_id: str) -> dict[str, Any]

Deprecated alias for setup.start_onboarding.

complete_onboarding_step

complete_onboarding_step(self, project_id: str) -> dict[str, Any]

Deprecated alias for setup.complete_onboarding_step.

dry_run_onboarding

dry_run_onboarding(self, project_id: str) -> dict[str, Any]

Deprecated alias for setup.dry_run_onboarding.

onboarding_status

onboarding_status(self, project_id: str) -> dict[str, Any]

Deprecated alias for setup.onboarding_status.