Dismiss a suggestion
curl --request POST \
--url https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "Already covered by an existing field description."
}
'import requests
url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore"
payload = { "reason": "Already covered by an existing field description." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Already covered by an existing field description.'})
};
fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore', 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/{suggestionId}/ignore",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'Already covered by an existing field description.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore"
payload := strings.NewReader("{\n \"reason\": \"Already covered by an existing field description.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Already covered by an existing field description.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Already covered by an existing field description.\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"detail": "Bad Request: prompt: Required",
"status": 400
}{
"detail": "Unauthorized: Missing or invalid API key",
"status": 401
}{
"detail": "Forbidden: AI query generation is not enabled for this organization",
"status": 403
}{
"detail": "Model 770e8400-e29b-41d4-a716-446655440002 not found",
"status": 404
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}AI Model Suggestions
Dismiss a suggestion
This endpoint requires Organization Admin permissions.
Dismisses a suggestion, removing it from the active list. Dismissed suggestions can be restored using the restore endpoint.
POST
/
v1
/
models
/
{modelId}
/
suggestions
/
{suggestionId}
/
ignore
Dismiss a suggestion
curl --request POST \
--url https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "Already covered by an existing field description."
}
'import requests
url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore"
payload = { "reason": "Already covered by an existing field description." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Already covered by an existing field description.'})
};
fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore', 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/{suggestionId}/ignore",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'Already covered by an existing field description.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore"
payload := strings.NewReader("{\n \"reason\": \"Already covered by an existing field description.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Already covered by an existing field description.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/suggestions/{suggestionId}/ignore")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"Already covered by an existing field description.\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"detail": "Bad Request: prompt: Required",
"status": 400
}{
"detail": "Unauthorized: Missing or invalid API key",
"status": 401
}{
"detail": "Forbidden: AI query generation is not enabled for this organization",
"status": 403
}{
"detail": "Model 770e8400-e29b-41d4-a716-446655440002 not found",
"status": 404
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"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 unique identifier of the model.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
The unique identifier of the suggestion to dismiss.
Example:
"b2c3d4e5-f6a7-8901-bcde-f12345678901"
Body
application/json
Optional free-text reason for dismissing the suggestion.
Maximum string length:
4000Example:
"Already covered by an existing field description."
Response
Suggestion dismissed successfully
Indicates the request was successful
Example:
true
Was this page helpful?
⌘I

