Skip to main content
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>'
{
  "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
  }
}

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId
string<uuid>
required

The ID of the shared model to list suggestions for.

Query Parameters

status
enum<string>
default:active

Filter suggestions by status:

  • active - Only active suggestions (default)
  • ignored - Only ignored suggestions
  • all - All suggestions regardless of status
Available options:
active,
ignored,
all
cursor
string

Cursor for keyset-based pagination. Use the id from the last suggestion in the previous page.

pageSize
integer
default:25

Number of suggestions to return per page. Defaults to 25, maximum 100.

Required range: 1 <= x <= 100

Response

List of suggestions for the model

records
object[]
required

List of AI-generated suggestions

pageInfo
object
required

Pagination information for paginated responses.