get_ai_note

ArtificialIntelligenceApi.get_ai_note(note_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a playground note including markdown content

Returns the note record plus NoteContent loaded from S3. Requires at least read-only access. Missing NoteType is backfilled to note.

Parameters:

  • note_id (str) – NoteId of the note to retrieve. (required)

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

  • _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:

NoteDetailsResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /ai/playground/notes/{note_id}

Success (HTTP 200)

Note retrieved successfully

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend