> ## 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.

# Secrets

# `synth_ai.research.secrets`

`client.research.secrets` — project secret refs (canonical over `credentials`).

## Classes

### `ResearchSecretsAPI` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/secrets.py#L11" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

Manage project-scoped secret references for provider and rollout auth.

Secrets are stored as org-managed refs — never pass raw credentials in run
launch payloads. Attach refs here, then reference them from project setup.

**Methods:**

#### `list` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/secrets.py#L21" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python theme={null}
list(self, project_id: str) -> List[Any]
```

List secret refs attached to a project.

**Args:**

* `project_id`: Target project id.
* `kind`: Optional filter (for example `provider`, `repo`).

**Returns:**

* List of secret ref records for the project.

#### `create` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/secrets.py#L38" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python theme={null}
create(self, project_id: str) -> Any
```

Create a secret ref on a project.

**Args:**

* `project_id`: Target project id.
* `kind`: Secret category understood by the backend.
* `label`: Human-readable label shown in the UI and launch preflight.
* `provider`: Optional provider slug when `kind` is provider-scoped.
* `funding_source`: Optional billing/funding source id.
* `credential_name`: Optional named credential in org storage.
* `metadata`: Optional opaque metadata map.

**Returns:**

* Created secret ref record.

#### `delete` <sup><a href="https://github.com/synth-laboratories/synth-ai/blob/main/synth_ai/research/secrets.py#L73" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python theme={null}
delete(self, project_id: str, secret_id: str) -> dict[str, Any]
```

Delete a project secret ref.

**Args:**

* `project_id`: Target project id.
* `secret_id`: Secret ref id returned from `list` or `create`.

**Returns:**

* Deletion acknowledgement payload.
