Knowledge Bases

Generate KB visualization plan

Ask a model which fields of the active schema are worth charting, and how, from the schema and a sample of the extraction records.

post/api/v0/knowledge-bases/{kb_id}/viz-plan

Request

Base URL
https://api.outerport.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/knowledge-bases/:kb_id/viz-plan/post.ts
A function with typed inputs. Its response is checked against the schema.

kb_idstring uuid required

user_hintstring

Optional guidance for the LLM when choosing visualizations.

sample_sizeinteger

Records shown to the model as examples of the data.

max_distinct_valuesinteger

A string field with at most this many distinct values is listed to the model value by value, so it can chart it and spot aliases.

max_tokensinteger

Output budget of the planning call.

reasoningstring nullable

Reasoning depth asked of the model; a depth the user saved for kb_viz_plan_model outranks it.

Successful Response

summary_metric_fieldstring nullable

value_aliasesobject

rationalestring nullable

sample_sizeinteger

record_countinteger

Nov 9, 2026ecd5b922e78a Revision changes
- info
  added the optional property to the response with the status
Oct 13, 20267f81908bcdfe Revision changes
- info
  endpoint added