Start a Ploti session

Open a working session; the first call for any question about a US address, parcel, zoning, owner, sale, permit, sign or site. Returns the session id needed by session-scoped tools, the session's Ploti link, and the guides to start from. Optionally sets the initial viewport. Call this first.

post/v1/tools/start_session

Request

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

Request body

titlestring required

Short label for this session, shown to the user in Ploti. Describe the task, e.g. 'Industrial sites near Tampa'.

placestring

A place to open the viewport on, as navigate takes it, e.g. 'Winter Garden, FL': the same as calling navigate with it straight after. Left out, the session has no viewport until navigate sets one.

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.