API Reference¶
Module-level functions¶
| Function | Description |
|---|---|
configure() |
Initialize the global client with your API key |
generate_spec() |
Generate a visualization spec from data and a prompt |
load_spec() |
Load a spec from a .nveil file |
session() |
Create a scoped session with workspace reuse |
show() |
Display a figure in the browser |
save_image() |
Export a figure to a static image |
save_html() |
Export a figure to interactive HTML |
Classes¶
| Class | Description |
|---|---|
NveilSpec |
Opaque visualization spec — render, save, load |
Session |
Scoped workspace for pipeline reuse |
Exceptions¶
| Exception | Description |
|---|---|
NveilError |
Base exception |
AuthenticationError |
Invalid or expired API key (401) |
ScopeError |
Missing permission scope (403) |
QuotaExceededError |
Rate limit exceeded (429) |
SpecGenerationError |
Server or local execution error |
IncompatibleDataError |
Data schema mismatch |