For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ask AI for queries and transformations

Ask AI enables you to work with APIs, SQL, data transformations, and much more, all through simple natural language prompts.

The Ask AI feature converts plain text instructions into working API requests, SQL queries, transformation scripts, and a variety of other outputs. Review and test the generated output against your source schema and expected results before using it in the app.

Ask AI for API

Ask AI simplifies working with APIs. You can type a request in plain English, provide a curl command, or link to Swagger documentation, and it can draft an API call for you to inspect and test.

What it can do:

  • Generate API requests from text, curl, or docs

  • Suggest fixes for failed requests

  • Transform responses into structured outputs

  • Handle pagination and sorting automatically

Examples:

  • “Get Deals with status = 'Won'” → Collection API call

spinner

Ask AI for SQL

Instead of writing queries manually, you can describe what you need and Ask AI creates the SQL for you. If the result fails, provide the error and expected output in a focused follow-up.

What it can do:

  • Translate text prompts into SQL queries

  • Detect and fix SQL errors

  • Transform results for dashboards or reports

Example:

  • “Get all transactions/orders where the amount > 100” → SQL query

spinner

If the generated query looks too broad, try refining your prompt with additional filters (e.g., date ranges or specific columns)

Ask AI for Transformations

Ask AI also supports transformations, making it easier to work with complex or nested data. You can quickly create or debug scripts without needing to code them from scratch.

What it can do:

  • Flatten nested JSON or API responses

  • Generate custom JavaScript transformations

  • Fix broken transformation logic

Example:

  • “Filter the API response to keep only these key fields: Service, Entity/Resource, Action Type, Endpoint URL, and Filters/Parameters.” → JavaScript transformation

spinner

To get the most out of Ask AI, keep these tips in mind:

  • Be specific in your prompts. The more details you give (fields, filters, conditions), the more accurate the output will be.

  • Always review before running. Check generated API calls, SQL queries, or scripts especially if they modify or delete data.

  • Test safely first. Run queries or actions on test data before applying them to production.

  • Iterate step by step. If the first result isn’t perfect, refine your prompt instead of starting over.

  • Use hints and context. Linking docs, curl commands, or schemas can help Ask AI generate better results.

Check the result

Test a read-only request first. Compare returned fields, filtering, and record counts with a known test case. For a write request, inspect the method, destination, inputs, and permissions before execution.

Continue with App Console and logs for Preview diagnostics.

Last updated

Was this helpful?