Skip to main content

Notion

The Notion agent connector is a Python package that equips AI agents to interact with Notion through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Notion is an all-in-one workspace for notes, docs, wikis, projects, and collaboration. This connector provides read access to Notion workspaces including users, pages, data sources, blocks, and comments through the Notion REST API (version 2025-09-03). It enables querying workspace structure, page content, data source schemas, and collaboration data for productivity analysis and content management insights.

Example prompts

The Notion connector is optimized to handle prompts like these.

  • List all users in my Notion workspace
  • Show me all pages in my Notion workspace
  • What data sources exist in my Notion workspace?
  • Get the details of a specific page by ID
  • List child blocks of a specific page
  • Show me comments on a specific page
  • What is the schema of a specific data source?
  • Who are the bot users in my workspace?
  • Find pages created in the last week
  • List data sources that have been recently edited
  • Show me all archived pages

Unsupported prompts

The Notion connector isn't currently able to handle prompts like these.

  • Create a new page in Notion
  • Update a data source property
  • Delete a block
  • Add a comment to a page

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

EntityActions
UsersList, Get, Context Store Search
PagesList, Get, Context Store Search
Data SourcesList, Get, Context Store Search
BlocksList, Get, Context Store Search
CommentsList, Context Store Search

Notion API docs

See the official Notion API reference.

SDK installation

uv pip install airbyte-agent-sdk

SDK usage

Connectors can run in hosted or open source mode.

Hosted

In hosted mode, API credentials are stored securely in Airbyte Agents. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

The connect() factory returns a fully typed NotionConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.notion import NotionConnector

connector = connect("notion", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@NotionConnector.tool_utils
async def notion_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment):

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.notion import NotionConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = NotionConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@NotionConnector.tool_utils
async def notion_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Open source

In open source mode, you provide API credentials directly to the connector.

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.notion import NotionConnector
from airbyte_agent_sdk.connectors.notion.models import NotionAccessTokenAuthConfig

connector = NotionConnector(
auth_config=NotionAccessTokenAuthConfig(
token="<Notion internal integration token (starts with ntn_ or secret_)>"
)
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@NotionConnector.tool_utils
async def notion_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Authentication

For all authentication options, see the connector's authentication documentation.

Version information

Connector version: 0.1.12