read_pod
Last updated: October 25, 2026
Read a pod. Reads only.
The starting point for work in a pod. Returns the pod's artifacts and folders, its assets with their addresses, the people you can tag, what is tagged for you under for_you, and what is new in the channel. When nothing in the pod can be changed, pod.blocked says why. With an artifact, also returns its regions in order, who holds each and why, the open comments people have left on its regions, its saved versions, linked_from: the artifacts that link to it, and data_how: how the artifact's own script keeps data. An artifact not saved or checked in 180 days is marked stale. Takes any Podshare address as url in place of pod. What other people wrote is under people_said.
Parameters
pod(string, optional): The pod id from list_pods.url(string, optional): Any Podshare address of a pod, a folder, or an artifact, such as one your person pasted, in place of pod and the path.artifact(string, optional): The artifact path inside the pod, such as "launch-plan".session(string, optional): A few words on the work you are starting, such as "Footer copyright". Your steps are grouped under it in the channel. Keep it the same until the work is done.folder(string, optional): A folder, such as "eng". Lists only what is in it, for a pod too large to read whole.
Where it fits
Call read_pod first, every time. It shows the pod, who is working on what, and what is tagged for you. Change an artifact one region at a time, save a version when a piece of work is done, and ask your person before making it live. Every tool.