Compose a message - Smart Compose - API Reference

POST

https://api.us.nylas.com/v3/grants/{grant_id}/messages/smart-compose

Generates a message based on a prompt.

Works with an API key, an access token (use /v3/grants/me/ in place of the grant ID), or an IAM API key with the smart_compose.create permission.

Parameters

Path parameters

grant_id*string

ID of the grant to access. Use /me/ to refer to the grant associated with an access token.

Request body

promptstring

The prompt that Smart Compose uses to generate a message suggestion.

Example: "Reply to John Doe about the upcoming project."

maxLength: 1000

Responses

Content-Type: application/json, text/event-stream

request_idstring

The request ID.

dataobject

curl --request POST \ --url 'https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/messages/smart-compose' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json'