NYnylas
Notetaker

Update scheduled Notetaker

Changed on

Updates the specified scheduled Notetaker bot. Only Notetakers in the scheduled state can be updated. After the bot joins the meeting, this endpoint returns 400 Bad Request with the message notetaker is not in scheduled state.

To upload a custom video output image, send the request as multipart/form-data with the JSON body in a part named notetaker and the image in a file part referenced by notetaker_settings.video_output.file_key. Small images (up to 1,376,256 decoded bytes) can be sent inline on application/json requests using video_output.media_type and video_output.data instead.

patch/v3/grants/{grant_id}/notetakers/{notetaker_id}

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Request body

join_timeinteger

When Notetaker should join the meeting, in seconds using the Unix timestamp format. If empty, Notetaker joins the meeting immediately.

If you provide a time that's in the past, Nylas returns an error.

config_idstring

The ID of an existing configuration to use for this Notetaker. Cannot be used together with notetaker_settings.

namestring

Deprecated. Use notetaker_settings.name instead. Cannot be used together with notetaker_settings or config_id.

Example request

{
  "join_time": 1732657774,
  "config_id": "d4e78fca-2a90-4b6e-91c3-a7f2bcb0d498",
  "notetaker_settings": {
    "name": "Acme Notetaker",
    "recording_type": "audio_video",
    "transcription": true,
    "transcription_settings": {
      "expected_languages": [
        "en",
        "es"
      ],
      "fallback_language": "en",
      "keywords": [
        "Nylas",
        "AssemblyAI"
      ],
      "use_speaker_names_as_keywords": true
    },
    "summary": true,
    "summary_settings": {
      "custom_instructions": "Summarize in bullet points."
    },
    "action_items": true,
    "action_items_settings": {
      "custom_instructions": "Only return the 5 most important action items."
    },
    "leave_after_silence_seconds": 600,
    "messages": {
      "on_join": [
        {
          "type": "text",
          "content": "👋 Hey team! I'm your AI notetaker — here to capture the key points.",
          "send_after_ms": 5000
        }
      ],
      "on_participant_join": [
        {
          "type": "text",
          "content": "👋 Welcome! Recording and transcription are running.",
          "debounce_ms": 3000
        }
      ]
    },
    "video_output": {
      "file_key": "avatar",
      "media_type": "image/png",
      "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
      "size": 184320,
      "preview_url": "https://storage.googleapis.com/...",
      "preview_url_expires_at": 1786128794
    },
    "retention_time": 604800
  },
  "meeting_settings": {
    "action_items": true,
    "action_items_settings": {
      "custom_instructions": "Only return the 5 most important action items."
    },
    "audio_recording": true,
    "leave_after_silence_seconds": 360,
    "summary": true,
    "summary_settings": {
      "custom_instructions": "Return this summary in the MEDPIC sales methodology."
    },
    "transcription": true,
    "video_recording": true,
    "transcription_settings": {
      "expected_languages": [
        "en",
        "es"
      ],
      "fallback_language": "en",
      "keywords": [
        "Nylas",
        "AssemblyAI"
      ],
      "use_speaker_names_as_keywords": true
    },
    "messages": {
      "on_join": [
        {
          "type": "text",
          "content": "👋 Hey team! I'm your AI notetaker — here to capture the key points.",
          "send_after_ms": 5000
        }
      ],
      "on_participant_join": [
        {
          "type": "text",
          "content": "👋 Welcome! Recording and transcription are running.",
          "debounce_ms": 3000
        }
      ]
    }
  },
  "name": "Nylas Notetaker"
}

Response

Success. Returns Notetaker bot.

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes