Show an output to the user

Display a checkpoint's entities, a materialized table's rows, a saved query's live results, or a saved filter's map. Returns viewUrl — the user-facing Ploti link for the artifact; create calls do not return one. Each call also creates a view-only link that needs no sign-in and lasts 7 days. Also returns a compact row preview as text and, in supported clients, an interactive panel that loads the full artifact separately. Use limit, offset, and columns to page or narrow the preview; expression columns from a checkpoint's table_config render in Ploti but are omitted from the preview. Use this tool to hand a result to the user rather than pasting rows into your reply. An answer about places is handed over as one filter (tools.filters.create) holding the result and the layer it rests on, and its viewUrl goes in your reply.

post/v1/tools/show_output

Request

  • Base URL: https://api.ploti.ai
  • URL: https://api.ploti.ai/v1/tools/show_output
  • 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.

kind'checkpoint' | 'table' | 'query' | 'filter' required

The kind of output the id names, as list_outputs groups it: a checkpoint's entities, a table's rows, a saved query's live results, or a filter's map.

idstring required

Checkpoint, materialized table, saved query, or filter id.

limitinteger

Rows in the text preview; 10 when left out. The interactive panel loads the full output on its own.

offsetinteger

The row the preview starts at, for paging through it; the first row when left out.

columnsstring[]

Columns to show in the preview, by name; left out, a checkpoint shows its table_config columns and a table or query its own.

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.