Turn a sentence into a filter, as the builder

Generate a complete filter to apply from the table's fields, example values, and current filter, or return a plain-language refusal.

POST/v1/apps/{appId}/tables/{tableId}/filters/suggest

Request

curl --request POST \
  --url 'https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sentence": "<string>"
}'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"sentence\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "sentence": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"sentence\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest", bytes.NewBuffer([]byte("{\"sentence\":\"<string>\"}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"sentence\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"sentence\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "ok": true,
    "filter": {
      "id": "<string>",
      "kind": "<string>",
      "mode": "and",
      "children": [
        {
          "id": "<string>",
          "kind": "<string>",
          "fieldId": "<string>",
          "op": "contains",
          "value": null
        }
      ]
    }
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Costs the organisation credits.

Requires the records:read scope. Operation apps.filters.suggest. MCP tool apps_filters_suggest. CLI: grid82 apps filters suggest (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	string	yes
`tableId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`sentence`	string	yes	Up to 600 characters.
`current`	FilterGroup	no

Response

application/json

Success

dataobjectrequired

Show child attributes

data.okbooleanrequired

data.filterobjectrequired

Show child attributes

data.filter.idstringrequiredlength: 1–64 chars

data.filter.kindstringrequired

data.filter.modeenum<string>requiredone of: and, or

data.filter.childrenobject[]requireditems: ≤ 50 items

Show child attributes

data.filter.children.idstringrequiredlength: 1–64 chars

data.filter.children.kindstringrequired

data.filter.children.fieldIdstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.filter.children.openum<string>requiredone of: contains, not_contains, starts_with, ends_with, is, is_not, is_empty, is_not_empty, gt, lt, gte, lte, before, after, on_or_before, on_or_after, is_any_of, is_none_of, has_any_of, has_all_of, has_none_of, is_checked, is_unchecked

data.filter.children.valueobject

curl --request POST \ --url 'https://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/filters/suggest' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "sentence": "<string>" }'

{ "data": { "ok": true, "filter": { "id": "<string>", "kind": "<string>", "mode": "and", "children": [ { "id": "<string>", "kind": "<string>", "fieldId": "<string>", "op": "contains", "value": null } ] } } }

Turn a sentence into a filter, as the builder

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown