Actions16
- Record Actions
- Attachment Actions
- Report Actions
- Schema Actions
Schema → Generate Schema
AI-generatedSummary
Generate a comprehensive tenant schema by discovering multiple tables in the Nexoid database, sampling recent records per table, and inferring fields, enums, references, and decimal hints to produce an enriched JSON schema draft suitable for AI and MCP workflows.
Inputs
- Authentication Mode (required) — Selects whether to authenticate using the generic API service account or a provided Nexoid session ID that preserves user-specific permissions.
- Provided Session ID — A Nexoid session_id to use for authentication instead of the API user account, required if Authentication Mode is 'Provided Session'.
- Sample Mode (required) — Defines how many recent records per table to inspect when inferring the schema. Options are Quick (100), Standard (500), Deep (2000), or Custom.
- Custom Sample Size — If Sample Mode is Custom, defines the exact number of recent records to sample per table (between 1 and 10,000). Defaults to 500.
- Table Include List (JSON Array) — Optional JSON array of table names to explicitly include for schema generation. If empty, all discovered tables are included.
- Table Exclude List (JSON Array) — Optional JSON array of table names to exclude from schema generation.
- Max Tables — Optional limit on how many tables to process during schema generation. Use 0 for no limit.
- Schema Overrides (JSON) — Optional JSON object for manual corrections or enrichment of the generated schema, such as setting decimal hints or adding notes.
- Max Examples Per Field — Maximum number of distinct example values to retain per field. Default is 5.
- Max Example Records — Maximum number of example records to include in the output schema. Default is 3.
Output shape
a single JSON object representing the generated tenant schema including metadata, tables with inferred field details, examples, and applied overrides
The output JSON schema includes a metadata section with generation timestamp, sample settings, and override structure, along with a list of tables. Each table contains its name, sample counts, fields with inferred types and notes, relationship hints, enums, decimal scale hints, and example records. User overrides are applied when provided. This operation may involve multiple API requests depending on the number of tables and sample size specified.
Examples
Example 1: Generate standard schema for all tables with default sampling
Authentication Mode set to 'API User', Sample Mode 'Standard (500)', no include/exclude tables, no overrides