List AI-generated suggestions
curl --request GET \
--url https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"records": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"category": "missing_context",
"title": "Document the orders view",
"rationale": "Users frequently ask what `status` means; documenting the view in ai_context improves AI answers.",
"priority": 1,
"proposedChanges": {
"kind": "context_edits",
"edits": [
{
"field": "ai_context",
"target": "views.orders",
"value": "The orders view contains one row per customer order."
}
]
},
"evidence": [
{
"type": "ai_chat",
"chatAiSessionId": "a1b2c3d4-5717-4562-b3fc-2c963f66afa6",
"capturedAt": "2026-06-24T09:12:33Z"
}
],
"ignoreReason": null,
"ignoredAt": null,
"ignoredBy": null,
"aiModifiedAt": "2026-06-25T16:10:58Z",
"createdAt": "2026-06-25T16:10:58Z",
"updatedAt": "2026-06-25T16:10:58Z"
},
{
"id": "b2c3d4e5-6717-4562-b3fc-2c963f66afa6",
"category": "missing_context",
"title": "Clarify the revenue measure",
"rationale": "The revenue measure lacks a description, leading to ambiguous AI responses.",
"priority": 3,
"proposedChanges": {
"kind": "context_edits",
"edits": [
{
"field": "ai_context",
"target": "views.orders.fields.revenue",
"value": "Revenue is recognized at order completion, net of refunds."
}
]
},
"evidence": [],
"ignoreReason": null,
"ignoredAt": null,
"ignoredBy": null,
"aiModifiedAt": "2026-06-24T11:05:00Z",
"createdAt": "2026-06-24T11:05:00Z",
"updatedAt": "2026-06-24T11:05:00Z"
}
],
"pageInfo": {
"hasNextPage": true,
"nextCursor": "b2c3d4e5-6717-4562-b3fc-2c963f66afa6",
"pageSize": 25,
"totalRecords": 47
}
}{
"detail": "Bad Request: Invalid cursor value",
"status": 400
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"detail": "Forbidden: Organization admin permission required",
"status": 403
}{
"detail": "Shared model with id 550e8400-e29b-41d4-a716-446655440000 does not exist",
"status": 404
}{
"error": "<response_code>",
"message": "<error_reason>"
}AI Model Suggestions
List AI-generated suggestions
This endpoint requires Organization Admin permissions.
Lists AI-generated suggestions for a shared model. Suggestions can be filtered by status and are returned with keyset-based pagination.
Suggestions are sorted by priority, creation date, and ID for stable pagination.
GET
/
v1
/
models
/
{modelId}
/
suggestions
List AI-generated suggestions
curl --request GET \
--url https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"records": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"category": "missing_context",
"title": "Document the orders view",
"rationale": "Users frequently ask what `status` means; documenting the view in ai_context improves AI answers.",
"priority": 1,
"proposedChanges": {
"kind": "context_edits",
"edits": [
{
"field": "ai_context",
"target": "views.orders",
"value": "The orders view contains one row per customer order."
}
]
},
"evidence": [
{
"type": "ai_chat",
"chatAiSessionId": "a1b2c3d4-5717-4562-b3fc-2c963f66afa6",
"capturedAt": "2026-06-24T09:12:33Z"
}
],
"ignoreReason": null,
"ignoredAt": null,
"ignoredBy": null,
"aiModifiedAt": "2026-06-25T16:10:58Z",
"createdAt": "2026-06-25T16:10:58Z",
"updatedAt": "2026-06-25T16:10:58Z"
},
{
"id": "b2c3d4e5-6717-4562-b3fc-2c963f66afa6",
"category": "missing_context",
"title": "Clarify the revenue measure",
"rationale": "The revenue measure lacks a description, leading to ambiguous AI responses.",
"priority": 3,
"proposedChanges": {
"kind": "context_edits",
"edits": [
{
"field": "ai_context",
"target": "views.orders.fields.revenue",
"value": "Revenue is recognized at order completion, net of refunds."
}
]
},
"evidence": [],
"ignoreReason": null,
"ignoredAt": null,
"ignoredBy": null,
"aiModifiedAt": "2026-06-24T11:05:00Z",
"createdAt": "2026-06-24T11:05:00Z",
"updatedAt": "2026-06-24T11:05:00Z"
}
],
"pageInfo": {
"hasNextPage": true,
"nextCursor": "b2c3d4e5-6717-4562-b3fc-2c963f66afa6",
"pageSize": 25,
"totalRecords": 47
}
}{
"detail": "Bad Request: Invalid cursor value",
"status": 400
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"detail": "Forbidden: Organization admin permission required",
"status": 403
}{
"detail": "Shared model with id 550e8400-e29b-41d4-a716-446655440000 does not exist",
"status": 404
}{
"error": "<response_code>",
"message": "<error_reason>"
}Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the shared model to list suggestions for.
Query Parameters
Filter suggestions by status:
active- Only active suggestions (default)ignored- Only ignored suggestionsall- All suggestions regardless of status
Available options:
active, ignored, all Cursor for keyset-based pagination. Use the id from the last suggestion in the previous page.
Number of suggestions to return per page. Defaults to 25, maximum 100.
Required range:
1 <= x <= 100Was this page helpful?
⌘I

