> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usesynth.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# 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`
```python theme={null}
setup(self) -> ResearchProjectsSetupAPI
```
Onboarding and runnable-project preparation.
#### `workspace`
```python theme={null}
workspace(self) -> ResearchProjectsWorkspaceAPI
```
Upload, download, and inspect project workspace inputs.
#### `repos`
```python theme={null}
repos(self) -> ResearchProjectsReposAPI
```
Attach source repositories to project workspace inputs.
#### `git`
```python theme={null}
git(self) -> ResearchProjectsGitAPI
```
Project git source connection and metadata.
#### `code`
```python theme={null}
code(self) -> ResearchProjectsCodeAPI
```
Download project code archives.
#### `objectives`
```python theme={null}
objectives(self) -> ResearchProjectsObjectivesAPI
```
Directed effort outcomes and objective status.
#### `milestones`
```python theme={null}
milestones(self) -> ResearchProjectsMilestonesAPI
```
Project and run-scoped milestones.
#### `runs`
```python theme={null}
runs(self) -> ResearchProjectsRunsAPI
```
List runs belonging to a project.
#### `create`
```python theme={null}
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`
```python theme={null}
create_runnable(self, request: SmrRunnableProjectRequest | Mapping[str, Any] | dict[str, Any]) -> ResearchCreateProjectResult
```
Create a runnable project (alias used internally by `create`).
#### `list`
```python theme={null}
list(self) -> List[ResearchProject]
```
List projects visible to the authenticated org.
#### `get`
```python theme={null}
get(self, project_id: str) -> ResearchProject
```
Fetch a single project by id.
#### `update`
```python theme={null}
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`
```python theme={null}
archive(self, project_id: str) -> dict[str, Any]
```
Archive a project (hidden from default `list`).
#### `unarchive`
```python theme={null}
unarchive(self, project_id: str) -> dict[str, Any]
```
Restore an archived project.
#### `setup_state`
```python theme={null}
setup_state(self, project_id: str) -> SmrProjectSetup
```
Deprecated alias for `setup.get`.
#### `prepare_setup`
```python theme={null}
prepare_setup(self, project_id: str) -> SmrProjectSetup
```
Deprecated alias for `setup.prepare`.
#### `start_onboarding`
```python theme={null}
start_onboarding(self, project_id: str) -> dict[str, Any]
```
Deprecated alias for `setup.start_onboarding`.
#### `complete_onboarding_step`
```python theme={null}
complete_onboarding_step(self, project_id: str) -> dict[str, Any]
```
Deprecated alias for `setup.complete_onboarding_step`.
#### `dry_run_onboarding`
```python theme={null}
dry_run_onboarding(self, project_id: str) -> dict[str, Any]
```
Deprecated alias for `setup.dry_run_onboarding`.
#### `onboarding_status`
```python theme={null}
onboarding_status(self, project_id: str) -> dict[str, Any]
```
Deprecated alias for `setup.onboarding_status`.