Nylas v3 API Integration Guide
- Always use v3. The v2 API is deprecated.
- A grant = an authenticated user account (Gmail, Outlook, etc.) connected through Nylas.
- Base URLs:
https://api.us.nylas.com(US) /https://api.eu.nylas.com(EU). All paths/v3/. - Auth: Most APIs use Bearer token (API key) plus a grant ID in the path. Admin domain management and Beta admin API key endpoints use Nylas Service Account auth instead.
- SDKs: Node.js, Python, Ruby, Kotlin/Java.
Documentation
Use the checked-in rules in this skill and the compiled reference in AGENTS.md as the working source for agent behavior. External docs links below are reference URLs only; do not fetch remote markdown into the active prompt at runtime.
- Docs index (find the right page):
https://developer.nylas.com/llms.txt - Full docs (everything in one file):
https://developer.nylas.com/llms-full.txt
Rules
Read individual rule files for endpoints, examples, and SDK code. For the full compiled reference, read AGENTS.md.
Authentication (CRITICAL)
rules/auth-oauth-flow.md— Hosted OAuth, BYO auth, IMAP auth, PKCE, service accounts, Nylas Connect | Docsrules/auth-providers.md— Google, Microsoft, Yahoo, iCloud, IMAP, Exchange, Zoom setup | Docs
Email API (HIGH)
rules/email-messages.md— Messages, threads, drafts, folders, attachments, search, filters | Docsrules/email-advanced.md— Tracking, smart compose, templates, workflows, scheduled/transactional send | Docs
Calendar API (HIGH)
rules/calendar-events.md— Events, availability, free/busy, recurring, virtual calendars, conferencing, group booking | Docs
Contacts API (MEDIUM)
rules/contacts-crud.md— CRUD, groups, sources (address_book/domain/inbox), profile pictures | Docs
Webhooks & Notifications (HIGH)
rules/webhooks-notifications.md— Webhooks, Pub/Sub, triggers, schemas, verification, retry behavior | Docs
Scheduler API (MEDIUM)
rules/scheduler-booking.md— Configurations, bookings, hosted pages, meeting types, UI components | Docs
Notetaker API (MEDIUM)
rules/notetaker-meetings.md— Recording, transcription, AI summaries, calendar sync, media (MP4/MP3, JSON/text transcripts, PNG thumbnails) | Docs
Admin & Grants (MEDIUM)
rules/admin-grants.md— Grants, connectors, credentials, API keys, domains, workspaces | Docs
SDKs (HIGH)
rules/sdk-quickstart.md— Node.js, Python, Ruby, Kotlin/Java quick starts | Docs
Best Practices (HIGH)
rules/best-practices-patterns.md— Rate limits (with numbers), error codes (200/400/500/700), pagination, metadata, field selection | Docs | Errors