Get session state

Report a session's viewport (place and zoom), whether its sandbox is running, when it expires, and its Ploti link. Call without a session id to list this workspace's open sessions, each with its id, viewport and link — useful for recovering an id you have lost.

post/v1/tools/get_session

Request

  • Base URL: https://api.ploti.ai
  • URL: https://api.ploti.ai/v1/tools/get_session
  • Auth: HTTP bearer

Request body

sessionIdstring

The session to report on, as start_session returned it. Omit to list this workspace's open sessions instead.

Response

What the tool returned: its text, any images, and structured data.

textstring required
dataunknown

Changes

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