Read a Ploti guide

Fetch a guide on how to work with Ploti's data and sandbox. Call without an id to list them. 'discovering-data' is worth reading for any task; for a quick single lookup it is often enough. Read the others when the task calls for them: 'navigation' before choosing where and how close to look, 'querying' before your first substantial SQL, 'parcel-data' before filtering parcels, 'spatial-analysis' before cross-layer spatial work, 'map-rendering' before custom-colored maps, 'ordinances' before municipal-code research, 'delivering-results' before creating checkpoints, tables, or files for the user, 'satellite-imagery' before rendering map images, 'branded-pdf-reports' before any PDF. python/<module> ids (python/checkpoint, python/schema, ...) return the exact deployed signatures — read one before your first call into that module. A guide read once stays read for the conversation; most questions need two or three, so read them together in one call with guide_ids.

post/v1/tools/read_guide

Request

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

Request body

guideIdstring

One guide to read, by the id this tool lists, e.g. 'querying' or 'python/database'. Leave out both ids to list the guides.

guideIdsstring[]

Guides to read together in one call, e.g. ['discovering-data', 'parcel-data']; read along with guide_id when both are given.

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.