API referenceObjectssession_resource

The session resource object

⚠️
Preview — this feature is being built; the design below is the spec.

The session_resource object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "sres_01JCB2E4G6J8L0N2Q4S6",
  "type": "session_resource",
  "session_id": "sesn_01JC7M2K4P6R8T0V2X4Z",
  "kind": "git_repository",
  "git": {
    "url": "https://git.example.com/acme/billing-service.git",
    "ref": "main",
    "commit": "4f1c2a9",
    "vault_secret": "git-read-token"
  },
  "mount_path": "/workspace/repo",
  "read_only": false,
  "status": "mounted",
  "error": null,
  "created_at": "2026-11-05T10:01:10Z",
  "updated_at": "2026-11-05T10:01:31Z"
}

Fields

FieldTypeDescription
idstringStarts with sres_.
typestringThe object type, always session_resource.
session_idstringThe related session.
kindstringfile, git_repository or memory_store.
gitobjectFor kind: git_repository: url, ref, the resolved commit, and the vault secret used to clone.
mount_pathstringAbsolute path under /workspace inside the session’s environment.
read_onlybooleanRead-only mounts reject writes from the agent’s tools.
statusstringpending, mounted, failed or removed.
errorobject or nullWhy mounting failed: code and message.
created_atstringWhen it was created, RFC 3339 UTC (some older objects use Unix seconds).
updated_atstringWhen it last changed.

Returned by

Was this page helpful?