Skip to content

Ask AI

Query your API's data in plain English from the console.

Ask AI lets you query the data in your API by typing natural-language questions. The console sends each question to your chosen LLM provider (Anthropic, OpenAI, or Gemini), the model picks the right resources and filters, and you get back a streamed answer scoped to the role you signed in with.

Ask AI is a console feature. The conversation lives in the Snaapi console, which talks to your provisioned API on your behalf. There is no separate external "Ask AI" REST endpoint for arbitrary clients to call. If you want to expose the same capability to external tools, see MCP server.

How it works

When you ask a question, the model is given your API's OpenAPI spec as tools. It chooses which resource endpoints to call, the console executes those calls under your session, and the results stream back as the answer takes shape. Behind the scenes:

  • Every call goes through the same authentication, RBAC, field-level permissions, and filters as a direct REST request.
  • Conversations are saved per API, so you can pick up where you left off or share interesting questions with teammates.
  • The provider key is yours. The console never proxies through a shared account, and tokens you spend show up on your provider's invoice.

Set up a provider

Ask AI does not work until at least one provider key is configured.

  1. From the API builder, open Settings and find the Providers section.
  2. Add a key for Anthropic, OpenAI, or Gemini (any one is enough).
  3. Save. Ask AI in the sidebar is enabled as soon as a key is present.

You can configure more than one provider and switch models per conversation. Keys are stored encrypted and never exposed to the front-end.

Ask a question

  1. Open the Ask AI tab on the API.
  2. Type a question like "How many orders did we get last week?" or "List the five highest-priced products that are still in stock."
  3. The answer streams as the model works. Tool calls are shown inline so you can see exactly which endpoints were hit.
  4. Follow-up questions reuse the same conversation context.

Conversations

Past conversations show up in the left rail. Open one to continue it, or start a new one with New conversation. Conversations are scoped to a single API and visible to anyone in the organization with access to that API.

What Ask AI can and cannot do

Ask AI sees your API the same way a developer with your role would. It can read records, apply filters, and aggregate counts when the underlying endpoint supports them. It cannot:

  • See data your role does not have permission to read.
  • Bypass field-level rules. Hidden fields stay hidden.
  • Write or delete records on its own.
  • Reach external services or hit URLs outside your API.

If a question requires data your role cannot see, the model will say so explicitly rather than guessing.

Related

  • MCP server connects Claude Desktop, Claude Code, Cursor, and other MCP clients to the same tool surface that Ask AI uses internally.
  • Permissions explain the field, filter, and check rules Ask AI honors on every tool call.