list_ai_notes

ArtificialIntelligenceApi.list_ai_notes(role_id, limit=None, offset=None, sortby=None, sortorder=None, filter_expression=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List playground notes accessible to the user

Returns notes the caller can access, with optional Title filtering, sort, pagination, and field projection. Note content is not included; use GET /ai/playground/notes/{note_id} for markdown content.

Parameters:

  • role_id (str) – Role identifier used for authorization. Missing this header returns AUTH-1001. (required)

  • limit (str) – Maximum notes to return on this page. Defaults to 5000. Values greater than 5000 return IPV-1050.

  • offset (str) – 1-based page start. offset=1 is the first note. Defaults to 1 when omitted.

  • sortby (str) – Attribute to sort by. Defaults to CreationTime.

  • sortorder (str) – Sort direction. desc (default) sorts newest first; asc sorts oldest first.

  • filter_expression (str) – Filter as key:value pairs separated by commas. Title uses wildcard * (case-insensitive). Example Title:meeting*.

  • projection_expression (str) – Comma-separated fields to keep on each list item after ChatName and ProjectName are resolved.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

NotesListResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /ai/playground/notes

Success (HTTP 200)

Successful API response

Request / response example

{
  "notes": [
    {
      "NoteId": "9c1e2a3b-4d5e-6789-abcd-ef0123456789",
      "Title": "Meeting recap",
      "NoteType": "note",
      "CreationTime": "2026-08-19 07:26:01",
      "CreatedBy": "jane.doe",
      "LastModifiedTime": "2026-08-19 07:26:01",
      "LastModifiedBy": "jane.doe",
      "ChatId": "N/A",
      "ChatName": "-",
      "ProjectId": "N/A",
      "ProjectName": "-",
      "AccessType": "owner"
    }
  ],
  "count": 1,
  "total_count": 1,
  "next_available": "no"
}

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend