Ask the AI about your data

Answers in natural language a question about the data of your account, optionally also searching the web.

Tool

filmo_ai_ask

Writeai:ask

ai:ask
120/min
May need an add-on
Server annotation: Open world
Requires human confirmation

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_ai_ask",
    "arguments": {
      "question": "<question>"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "answer": "<answer>",
      "needsMoreContext": true,
      "webSearchSources": [
        {
          "url": "https://example.com",
          "title": "Example",
          "favicon": "<favicon>"
        }
      ]
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

Requires human confirmation

Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone.

Server annotation

It spends AI credits of the account and can search the web: a stronger vector for instruction injection than free-text fields. It is annotated as not read-only for that reason.

It NEVER writes anything: the engine runs without a single write tool loaded, and what it can read is bounded by the permission guardrail of the owner of the API key, table by table. It consumes AI credits of the account: without quota it responds 402 addon_required without ever asking the model. It can take tens of seconds on questions that chain several queries; if needsMoreContext comes true, the answer is empty and you should rephrase with more detail instead of retrying the same.

Arguments

questionstringRequired

Natural-language question about the data of your account. Required.

Limits: min length 1, max length 4000

webSearchbooleandefault:false

Also allows web search to answer. Defaults to false: only the data of the account is consulted.

modestringdefault:"instant"

Answer mode. Today only "instant" (a single pass, no conversation). Documented so that future modes are additive.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

answerstring

Answer in markdown. Empty string when needsMoreContext is true.

needsMoreContextboolean

True when the AI finished without being able to answer and needs more context. In that case answer comes empty: rephrase the question with more detail instead of retrying as is.

webSearchSourcesobject[]

Cited web sources. Empty if web search was not requested or if none was used.

Show child attributes

webSearchSources.urlstring

URL of the consulted source.

webSearchSources.titlestring

Source title.

webSearchSources.faviconstring

URL of the site favicon, to render the source.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

Sample prompts

Ask the account: which customers rented the most last quarter?

The same operation by REST

This tool runs POST /api/v1/ai/ask.

AI
Ask the AI about your data
Answers in natural language a question about the data of your account, optionally also searching the web.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

Sample prompts

The same operation by REST

Related pages

Ask the AI about your data

Safe writes

Errors