> For the complete documentation index, see [llms.txt](https://docs.tonic.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tonic.ai/app/api.md).

# Using the Structural API

- [About the Structural API](https://docs.tonic.ai/app/api/api-documentation.md)
- [Getting an API token](https://docs.tonic.ai/app/api/tonic-api-get-token.md)
- [Getting the workspace ID](https://docs.tonic.ai/app/api/getting-the-workspace-id.md)
- [Using the Structural API to perform tasks](https://docs.tonic.ai/app/api/quick-start-guide.md)
- [Configure environment settings](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-configure-environment-settings.md)
- [Manage generator presets](https://docs.tonic.ai/app/api/quick-start-guide/api-generator-presets.md)
- [Retrieving the list of generator presets](https://docs.tonic.ai/app/api/quick-start-guide/api-generator-presets/api-generator-presets-list.md)
- [Structure of a generator preset](https://docs.tonic.ai/app/api/quick-start-guide/api-generator-presets/structure-of-a-generator-preset.md)
- [Creating a custom generator preset](https://docs.tonic.ai/app/api/quick-start-guide/api-generator-presets/api-generator-presets-create.md)
- [Updating an existing generator preset](https://docs.tonic.ai/app/api/quick-start-guide/api-generator-presets/api-generator-presets-update.md)
- [Deleting a generator preset](https://docs.tonic.ai/app/api/quick-start-guide/api-generator-presets/api-generator-presets-delete.md)
- [Manage custom sensitivity rules](https://docs.tonic.ai/app/api/quick-start-guide/api-custom-sensitivity-rules.md)
- [Create a workspace](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-create-workspace.md)
- [Connect to source and destination data](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-data-connections.md)
- [Manage file groups in a file connector workspace](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-file-groups.md)
- [Assign table modes and filters to source database tables](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-table-modes.md)
- [Set column sensitivity](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-column-sensitivity.md)
- [Assign generators to columns](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment.md)
- [Applying all recommended generators](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/applying-all-recommended-generators.md)
- [Getting the generator IDs and available metadata](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/tonic-api-generator-get-ids-metadata.md)
- [Updating generator configurations](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/updating-generator-configurations.md)
- [Structure of a generator assignment](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/tonic-api-generator-assignment-structure.md)
- [Generator API reference](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference.md)
- [Address (AddressGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-address.md)
- [Algebraic (AlgebraicGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-algebraic.md)
- [Alphanumeric String Key (AlphaNumericPkGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-alphanumeric-string-key.md)
- [Array Character Scramble (ArrayTextMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-array-character-scramble.md)
- [Array JSON Mask (ArrayJsonMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-array-json-mask.md)
- [Array Regex Mask (ArrayRegexMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-array-regex-mask.md)
- [ASCII Key (AsciiPkGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-ascii-key.md)
- [Business Name (BusinessNameGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-businessnamegenerator.md)
- [Categorical (CategoricalGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-categorical.md)
- [Character Scramble (TextMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-character-scramble.md)
- [Character Substitution (StringMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-character-substitution.md)
- [Company Name (CompanyNameGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-company-name.md)
- [Conditional (ConditionalGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-conditional.md)
- [Constant (ConstantGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-constant.md)
- [Continuous (GaussianGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-continuous.md)
- [Cross Table Sum (CrossTableAggregateGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-cross-table-sum.md)
- [CSV Mask (CsvMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-csv-mask.md)
- [Custom Categorical (CustomCategoricalGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-custom-categorical.md)
- [Date Truncation (DateTruncationGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-date-truncation.md)
- [Email (EmailGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-email.md)
- [Event Timestamps (EventGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-event-timestamps.md)
- [File Name (FileNameGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-file-name.md)
- [Find and Replace (FindAndReplaceGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-find-and-replace.md)
- [Finnish Personal Identity Code (FinnishPicGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-finnish-pic.md)
- [FNR (FnrGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-fnr.md)
- [Geo (GeoGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-geo.md)
- [HIPAA Address (HipaaAddressGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-hipaa-address.md)
- [Hostname (HostnameGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-hostname.md)
- [HStore Mask (HStoreMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-hstore-mask.md)
- [HTML Mask (HtmlMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-html-mask.md)
- [IBAN (IbanGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/iban-ibangenerator.md)
- [Integer Key (IntegerPkGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-integer-key.md)
- [International Address (InternationalAddressGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/international-address-internationaladdressgenerator.md)
- [IP Address (IPAddressGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-ip-address.md)
- [JSON Mask (JsonMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-json-mask.md)
- [MAC Address (MACAddressGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-mac-address.md)
- [Mongo ObjectId Key (ObjectIdPkGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-objectid-key.md)
- [Name (NameGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-name.md)
- [Noise Generator (NoiseGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-noise-generator.md)
- [Null (NullGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-null.md)
- [Numeric String Key (NumericStringPkGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-numeric-string-key.md)
- [Passthrough (PassthroughGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-passthrough.md)
- [Phone (USPhoneNumberGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-phone.md)
- [Random Boolean (RandomBooleanGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-random-boolean.md)
- [Random Double (RandomDoubleGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-random-double.md)
- [Random Hash (RandomStringGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-random-hash.md)
- [Random Integer (RandomIntegerGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-random-integer.md)
- [Random Timestamp (RandomTimestampGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-random-timestamp.md)
- [Random UUID (UUIDGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-random-uuid.md)
- [Regex Mask (RegexMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-regex-mask.md)
- [Sequential Integer (UniqueIntegerGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-sequential-integer.md)
- [Shipping Container (ShippingContainerGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-shipping-container.md)
- [SIN (SINGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-sin.md)
- [SSN (SsnGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-ssn.md)
- [Struct Mask (StructMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-struct-mask.md)
- [Text Composition (TextCompositionGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/text-composition-textcompositiongenerator.md)
- [Timestamp Shift (TimestampShiftGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-timestamp-shift.md)
- [Unique Email (UniqueEmailGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-unique-email.md)
- [URL (UrlGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-url.md)
- [UUID Key (UuidPkGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-uuid-key.md)
- [Valid Address (ValidAddressGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/valid-address-validaddressgenerator.md)
- [XML Mask (XmlMaskGenerator)](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-xml-mask.md)
- [Configure subsetting](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-subsetting-config.md)
- [Check for and resolve schema changes](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-schema-changes.md)
- [Run data generation jobs](https://docs.tonic.ai/app/api/quick-start-guide/tonic-api-data-generation.md)
- [Schedule data generation jobs](https://docs.tonic.ai/app/api/quick-start-guide/api-data-generation-schedule.md)
- [Using the Structural MCP server](https://docs.tonic.ai/app/api/structural-mcp-server.md)
- [Example script: Starting a data generation job](https://docs.tonic.ai/app/api/api-examples.md)
- [Example script: Polling for a job status and creating a Docker package](https://docs.tonic.ai/app/api/example-polling-for-a-job-status-+-creating-a-docker-package.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tonic.ai/app/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.