create_ai_note

ArtificialIntelligenceApi.create_ai_note(role_id, note_create_request, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a playground note or prompt

Creates a note owned by the caller. Title and NoteContent are required. NoteContent is stored as markdown in S3 (max 50000 characters). ProjectLevelAccess is set to none on create.

Parameters:

  • role_id (str) – User role id (required)

  • note_create_request (NoteCreateRequest) – (required)

  • content_type (str)

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

NotesCreateResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: POST /ai/playground/notes

Request

Request / response example

{
  "Title": "Meeting recap",
  "NoteContent": "## Summary\nCaptured action items from the weekly review.",
  "NoteType": "note",
  "ChatId": "N/A",
  "ProjectId": "N/A",
  "Sources": []
}

Success (HTTP 200)

Note created successfully

Request / response example

{
  "Message": "Note created successfully",
  "NoteId": "9c1e2a3b-4d5e-6789-abcd-ef0123456789"
}

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend