Read a file's metadata

GET /api/v1/code/files/{fileId} on the Caveman Cloud control plane. Requires the code:read scope. Not exposed to autonomous agents: Caveman Code files are the org's inputs for sessions and the outputs sessions wrote, uploaded and read through the Agents API by a person or a service account's key. An agent in a session reads its attached files at /mnt/session/uploads and writes /mnt/session/outputs through its runtime, never through a control-plane connection.

get/code/files/{fileId}

Request

  • Base URL
    https://api.caveman.so/api/v1
  • URL
    https://api.caveman.so/api/v1/code/files/{fileId}
  • Auth
    • OAuth 2
      Authorization code: /api/v1/oauth/authorize
      Token URL: /api/v1/oauth/token scopes: code:read
    • or HTTP bearer
    • or API key in cookie cave_access
    • or API key in cookie __Secure-cave_identity.session_token

Response

The file

idstring uuid required
namestring required

One path segment; an input mounts at /mnt/session/uploads/<name>.

media_typestring required
size_bytesinteger required
sha256string required
purpose'input' | 'output' required

input: uploaded for sessions to read; output: a session wrote it under /mnt/session/outputs/.

session_idstring uuid
workspace_idstring uuid
pathstring

An output's path under /mnt/session/outputs/.

created_by_user_idstring uuid
created_by_service_account_idstring uuid
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.