Vue Embedded AnalyticsStudio API Reference

Returns a plain typed namespace exposing AI-relevant information about this Studio instance. Synchronous surfaces (schema, catalogue, vocabulary, fragments) are cheap reads — schema and catalogue re-evaluate current state on every call. Async surfaces (health) perform data-engine round-trips.

Returns the built Studio AI tools, bound to this Studio instance and ready for an agent to run. They read live dashboard state at execute time, so pull the toolkit once and close over it when declaring an agent's tools (e.g. inside ai: ({ api }) => createAiHarness(api, ...)).

Build a tool an agent can list, bound to this Studio instance. Pass one of:

{ name, description, command, result } - a tool whose action is an AgAiCommand.

The command's own input shape is the tool's schema; result turns what the command returned into the response the LLM sees.

{ name, description, params, execute } - a tool that runs its own execute, for anything

that is not a single command. Build the result with ctx.success / ctx.error.

{ kind: 'server', name, description, params } - declared here, executed by the agent's own

harness. Studio advertises the schema and never runs it.

{ kind: 'provided', name, description, provider } - hosted and run by the LLM provider;

provider is passed through to the adapter untouched. The returned tool reads live state when it executes, so build it once and list it from an agent's tools callback.

Resolve an AI command bound to this Studio instance. The argument is either:

a factory callback (builder, lenses) => { input, execute } for a

custom command; the returned AgAiCommand exposes toJSONSchema(), parse(), and apply().

a built-in command reference { type: 'AgX', params? } to retrieve

one of the commands shipped with Studio. The built-in ships the schema + execute; the consuming AI library adds the name, description, status text, and UI. Name, description, status text, and UI belong to the consuming AI library in both cases.

Reload all data from the data sources.

Will destroy the Studio instance and release resources. If you are using a framework you do not need to call this, as Studio links in with the framework lifecycle. However if you are using native JavaScript, you need to call this to avoid a memory leak in your application.

Returns the studioId for the current Studio instance as specified via the Studio property studioId or the auto assigned Studio ID if none was provided.

Returns the Studio properties value for a provided key.

Updates a single Studio property to the new value provided. (Cannot be used on Initial properties.) If updating multiple options, it is recommended to instead use api.updateProperties() which batches update logic.

Updates the provided subset of Studio properties with the provided values. (Cannot be used on Initial properties.)

Get the current state of Studio. Can be used in conjunction with the initialState Studio property or api.setState() to save and restore Studio state.

Set the current state of Studio. Can be used in conjunction with api.getState() or onStateUpdated to save and restore Studio state. The state is expected to be a full state object, not a partial state object. State must be updated immutably as Studio uses reference equality to determine which parts of state have changed.

Undo the last change to the durable document state (widgets, layout, filters, schema). View state such as the selected page or selection is left as it is, then brought back into view for the restored change. No-op when there is nothing to undo (getHistory().undo is empty). Pass a getHistory().undo entry's id to undo every change back through that entry in a single step; an unknown id is a no-op.

Redo the change most recently undone. No-op when there is nothing to redo (getHistory().redo is empty). Making a fresh change discards the redo branch. Pass a getHistory().redo entry's id to redo every change forward through that entry in a single step; an unknown id is a no-op.

The editing history: the live state plus what undo() and redo() would step through, each entry labelled and timestamped. Drives control enablement (an empty undo stack means there is nothing to undo) and a history list. History does not survive loading new state.

Discard the undo and redo history, so getHistory() returns empty stacks and undo()/redo() become no-ops until the next change. The live state is untouched.

Execute an action for a widget. Action can be one of the default actions ('duplicate' or 'delete'), or an action specific to that widget.