Skip to main content

Secrets

The public API includes session-scoped secret routes.

Routes​

Key routes include:

  • /v1/sessions/{sessionId}/secrets
  • /v1/sessions/{sessionId}/secrets/{secretName}

How to think about secrets​

Secrets are workflow inputs and protected values, not regular filesystem content.

Use the secrets surface when your workflow needs:

  • Session-specific credentials.
  • Secret references for tools.
  • Controlled retrieval or update paths separate from normal files.

Design guidance​

  • Never store sensitive values in ordinary files unless your workflow explicitly requires that outcome.
  • Use the dedicated secrets routes for secret-aware workflows.
  • Keep secret handling separate from annotations, logs, and general cache entries.