Read one window of a text file on an agent's disk

Returns text/plain for a text file. This is the editor route: a file that is not text answers 415, and a file over the 2 MiB text cap answers 413 unless a window was asked for. Both refusals carry a download_url for the route that does serve those bytes. Use offset and limit to page through a file of any size; every 200 states what it covered in X-File-Offset, X-File-Returned-Bytes, X-File-Size and X-File-Truncated, so a short body is never silent. The disk is served directly, so an idle agent's files are readable with no running pod.

get/v1/agents/{agentID}/files/read

Request

  • Base URL: https://api.plori.ai
  • URL: https://api.plori.ai/v1/agents/{agentID}/files/read
  • Auth: HTTP bearer

Path parameters

agentIDstring uuid required

Query parameters

pathstring required

The file's path in the Workspace files, rooted at the Workspace root.

offsetinteger

Byte offset of the first byte to return. Default 0.

limitinteger

How many bytes to return, clamped to the 2 MiB per-call cap. Absent or 0 means the cap.

Response

The requested window of the file, as text.

Changes

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