Skip to main content

​
synth_ai.research.secrets

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

​
Classes

​
ResearchSecretsAPI

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 

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 

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 

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.