API reference
Notetaker
Return Notetaker media links

GET

https://api.us.nylas.com/v3/grants/{grant_id}/notetakers/{notetaker_id}/media

Return Notetaker media links

Returns a list of links to media generated by the specified Notetaker bot.

Works with an API key or an IAM API key with the notetakers.read permission.

Parameters

Path parameters

grant_id*string

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

Example: "[email protected]"

notetaker_id*string

ID of the Notetaker bot to access.

Responses

request_idstring

The request ID.

dataobject

The media files for a Notetaker. Each file is present only if Nylas generated it. The recording, transcript, summary, and action items also require the matching Notetaker setting.

action_itemsobject

Details about the action items from the meeting.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "meeting_action_items.json"

sizeinteger

The size of the file, in bytes.

Example: 289

ttlnumber

Seconds remaining until the file is deleted from Nylas servers. This is the difference between expires_at and the time when you made your request. Download URLs expire separately, 60 minutes after they're generated.

Example: 3600

typestring

The file type.

Example: "application/json"

urlstring

A link to the action items.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

recordingobject

Details about the meeting recording.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

durationinteger

The duration of the recording, in seconds.

Example: 1800

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "meeting_recording.mp4"

sizeinteger

The size of the file, in bytes.

Example: 52428800

ttlnumber

Example: 3600

typestring

The file type.

Example: "video/mp4"

urlstring

A link to the meeting recording.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

summaryobject

Details about the meeting summary.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "meeting_summary.json"

sizeinteger

The size of the file, in bytes.

Example: 437

ttlnumber

Example: 3600

typestring

The file type.

Example: "application/json"

urlstring

A link to the summary.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

thumbnailobject

Details about the meeting thumbnail.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "thumbnail.png"

sizeinteger

The size of the file, in bytes.

Example: 437

ttlnumber

Example: 3600

typestring

The file type.

Example: "image/png"

urlstring

A link to the thumbnail.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

transcriptobject

Details about the meeting transcript.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "transcript.json"

sizeinteger

The size of the file, in bytes.

Example: 10240

ttlnumber

Example: 3600

typestring

The file type.

Example: "application/json"

urlstring

A link to the meeting transcript.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

Multi-Status. Returns the available Notetaker media in the same format as a 200 response, and lists the enabled files that Nylas couldn't generate in data.errors.

request_idstring

The request ID.

dataobject

The media files for a Notetaker. Each file is present only if Nylas generated it. The recording, transcript, summary, and action items also require the matching Notetaker setting.

action_itemsobject

Details about the action items from the meeting.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "meeting_action_items.json"

sizeinteger

The size of the file, in bytes.

Example: 289

ttlnumber

Example: 3600

typestring

The file type.

Example: "application/json"

urlstring

A link to the action items.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

recordingobject

Details about the meeting recording.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

durationinteger

The duration of the recording, in seconds.

Example: 1800

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "meeting_recording.mp4"

sizeinteger

The size of the file, in bytes.

Example: 52428800

ttlnumber

Example: 3600

typestring

The file type.

Example: "video/mp4"

urlstring

A link to the meeting recording.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

summaryobject

Details about the meeting summary.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "meeting_summary.json"

sizeinteger

The size of the file, in bytes.

Example: 437

ttlnumber

Example: 3600

typestring

The file type.

Example: "application/json"

urlstring

A link to the summary.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

thumbnailobject

Details about the meeting thumbnail.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "thumbnail.png"

sizeinteger

The size of the file, in bytes.

Example: 437

ttlnumber

Example: 3600

typestring

The file type.

Example: "image/png"

urlstring

A link to the thumbnail.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

transcriptobject

Details about the meeting transcript.

created_atnumber

When the file was created, in seconds using the Unix timestamp format.

Example: 1703088000

expires_atnumber

When the file will be deleted from the Nylas servers, in seconds using the Unix timestamp format.

Example: 1704297600

namestring

The file name.

Example: "transcript.json"

sizeinteger

The size of the file, in bytes.

Example: 10240

ttlnumber

Example: 3600

typestring

The file type.

Example: "application/json"

urlstring

A link to the meeting transcript.

Example: "https://storage.googleapis.com/nylas-notetaker-uc1-prod-notetaker/..."

errorsarray<object>

Enabled files that Nylas couldn't generate. Present only in 207 responses.

Array items:

artifactstring

The file that Nylas couldn't generate.

summaryaction_items

Example: "summary"

codestring

Why Nylas couldn't generate the file.

generation_failed

Example: "generation_failed"

request_idstring

The request ID.

errorobject

The response error object.

typestring

The error type.

messagestring

The error message.

provider_errorobject

The error from the provider.

request_idstring

The request ID.

errorobject

The response error object.

typestring

The error type.

messagestring

The error message.

provider_errorobject

The raw error from the provider, if available

codestring

messagestring

Gone. The requested media has been deleted after exceeding the Notetaker's retention period. The response body is a plain-text string. Re-downloading is not possible — see Notetaker retention policies for details on configuring retention_time.

string

Example: "media deleted"

Rate limited. The provider or Nylas throttled the request. If a provider throttles a request and says how long to wait, the Retry-After header gives that number of seconds. When the header is missing, retry with exponential backoff. See 429 rate limit errors by provider.

request_idstring

The request ID.

errorobject

The response error object.

typestring

The error type.

messagestring

The error message.

provider_errorobject

The provider's own error, when the provider returned one.

GEThttps://api.us.nylas.com/v3/grants/nyla%40example.com/notetakers/{notetaker_id}/media

API key

Find your API key in the Nylas Dashboard under API Keys in your application settings.

Server

Path parameters

grant_idrequiredstring

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

notetaker_idrequiredstring

ID of the Notetaker bot to access.