List available data layers

What data exists in this session's viewport — requires a viewport, so call navigate first. By default, returns only queryable layers. query is a substring match over layer ids, names, tables, categories and descriptions — direct matches rank first and description-only matches trail, so expect a low-relevance tail. include_locked=true lists everything; locked results say why they are locked. Use tools.schema inside execute_python for fields, types and sampled values.

post/v1/tools/list_layers

Request

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

Request body

sessionIdstring required

The id start_session returned. Lost it? get_session without an id lists this workspace's open sessions.

querystring

Optional search across layer ids, names, table names and descriptions, e.g. 'zoning' or 'flood'.

includeLockedboolean

Also list plan-locked catalog layers in the unfiltered listing. With query, locked matches are always included regardless of this flag. Defaults to false. See discovering-data for when to surface locked data.

limitinteger

Layers per page; 25 when left out.

offsetinteger

Where the page starts, as the previous reply's next offset; the first layer when left out.

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.