Notion: Create a data source
Notion dataSources.createADatabase: arguments, response, policy and SDK examples.
← Data sources operations · Get started
Operation notion.create_a_database
Provider route: POST /v1/data_sources. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/notion with npm, or alter-sdk-notion with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { NotionIntegration } from "@alter-ai/notion";
async function execute(input: Parameters<NotionIntegration["dataSources"]["createADatabase"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new NotionIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.dataSources.createADatabase(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_notion import NotionIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = NotionIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.data_sources.create_a_database(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Required within parent | |
body.icon | JSON | Optional | Page icon. |
body.icon (oneOf 1) | Model | Alternative | Expand Create a database — request body — body icon |
body.icon (oneOf 2) | null | Alternative | |
body.parent | Model | Required within parent | Expand Create a data source — request body — body parent An object specifying the parent of the new data source to be created. |
body.properties | object | Required within parent | Property schema of data source. Additional keys: see wildcard field |
body.properties.* | Model | Additional keys | Expand Create a data source — request body — body properties value |
body.title | array | Optional | Title of data source as it appears in Notion. Maximum items: 100 |
body.title[] | Model | Each item | Expand Create a database — request body — body title item |
Referenced models: Create a database — request body — body icon, Create a data source — request body — body parent, Create a data source — request body — body properties value, Create a database — request body — body title item
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Create a data source — response body — object data source — partial Data Source Object Response |
$ (anyOf 2) | Model | Alternative | Expand Create a data source — response body — object data source — data Source Object Response |
Referenced models: Create a data source — response body — object data source — data Source Object Response, Create a data source — response body — object data source — partial Data Source Object Response
Schemas
Section titled “Schemas”119 more schemas are linked from the tables above, on the schema pages.
Create a data source — response body — object data source — data Source Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
cover | JSON | Required within parent | The cover of the data source. |
cover (anyOf 1) | Model | Alternative | Expand Update page — response body — object page cover value |
cover (anyOf 2) | null | Alternative | |
created_by | Model | Required within parent | Expand Update page — response body — object page created by The user who created the data source. |
created_time | string | Required within parent | The time when the data source was created. Format: date-time |
database_parent | Model | Required within parent | Expand Create a database — response body — object database parent The parent of the data source's containing database. This is typically a page, block, or workspace, but can be another database in the case of wikis. |
database_type | JSON | Required within parent | The type of typed database this data source belongs to, or `null` for a regular data source. |
database_type (anyOf 1) | string | Alternative | One of: `tasks`, `projects`, `sprints`, `docs`, `wiki`, `meetings`, `meeting_notes`, `skills`, `github_prs` Known values: tasks, projects, sprints, docs, wiki, meetings, meeting_notes, skills, github_prs |
database_type (anyOf 2) | null | Alternative | |
description | array | Required within parent | The description of the data source. Maximum items: 100 |
description[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
icon | JSON | Required within parent | The icon of the data source. |
icon (anyOf 1) | Model | Alternative | Expand Get agent — response body — icon value |
icon (anyOf 2) | null | Alternative | |
id | string | Required within parent | The ID of the data source. Format: uuid |
in_trash | boolean | Required within parent | Whether the data source is in the trash. |
is_inline | boolean | Required within parent | Whether the data source is inline. |
last_edited_by | Model | Required within parent | Expand Update page — response body — object page created by The user who last edited the data source. |
last_edited_time | string | Required within parent | The time when the data source was last edited. Format: date-time |
object | string | Required within parent | The data source object type name. Must equal: data_source |
parent | Model | Required within parent | Expand Create a data source — response body — object data source parent The parent of the data source. |
properties | object | Required within parent | The properties schema of the data source. Additional keys: see wildcard field |
properties.* | Model | Additional keys | Expand Create a data source — response body — object data source properties value |
public_url | JSON | Required within parent | The public URL of the data source if it is publicly accessible. |
public_url (anyOf 1) | string | Alternative | |
public_url (anyOf 2) | null | Alternative | |
sync_metadata | object | Optional | Sync identity and available health, included when listing or retrieving data sources. Additional keys: allowed |
sync_metadata.external_collection_type | string | Optional | The provider of a legacy synced data source: Jira or Salesforce. Values are case-sensitive. Known values: Jira, Salesforce |
sync_metadata.external_database_sync | object | Optional | Stored identity of an external database sync. Additional keys: allowed |
sync_metadata.external_database_sync.provider | string | Required within parent | The sync provider: github (GitHub), jira (Jira), or salesforce (Salesforce). Known values: github, jira, salesforce |
sync_metadata.external_database_sync.sync_id | string | Required within parent | The stored sync ID. This is not a credential. Format: uuid |
sync_metadata.health | JSON | Optional | Live collection sync health. Null means unavailable, not unhealthy. Missing timestamps are unknown. |
sync_metadata.health (anyOf 1) | null | Alternative | |
sync_metadata.health (anyOf 2) | Model | Alternative | Expand Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady |
sync_metadata.health (anyOf 3) | Model | Alternative | Expand Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady |
sync_metadata.health (anyOf 4) | object | Alternative | Additional keys: allowed |
sync_metadata.health (anyOf 4).paused | boolean | Required within parent | Must equal: true |
sync_metadata.owner_user_id | string | Optional | Notion user who owns the sync credential, included when health is available. Format: uuid |
sync_metadata.resource | string | Optional | Provider resource synced to this data source, when available. |
sync_metadata.sync_id | string | Optional | The stored sync ID when provider details are unavailable. This is not a credential. Format: uuid |
sync_metadata.sync_state | Model | Optional | Expand Create a data source — response body — object data source sync metadata sync state |
sync_metadata.synced_collection_key | string | Optional | Opaque, developer-defined collection key for a worker sync. It is not a globally unique ID or a credential. Worker status is not included. |
title | array | Required within parent | The title of the data source. Maximum items: 100 |
title[] | Model | Each item | Expand Retrieve a page property item — response body — value Title title |
url | string | Required within parent | The URL of the data source. |
Referenced models: Create a data source — response body — object data source properties value, Update page — response body — object page cover value, Get agent — response body — icon value, Create a data source — response body — object data source parent, Create a database — response body — object database parent, Update page — response body — object page created by, Retrieve a page property item — response body — value Title title, Create a data source — response body — object data_source / sync_metadata / health / ok False, stage: backfilling, initializing, steady, Create a data source — response body — object data_source / sync_metadata / health / ok True, stage: backfilling, initializing, steady, Create a data source — response body — object data source sync metadata sync state
Create a data source — response body — object data source — partial Data Source Object Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the data source. Format: uuid |
object | string | Required within parent | The data source object type name. Must equal: data_source |
properties | object | Required within parent | The properties schema of the data source. Additional keys: see wildcard field |
properties.* | Model | Additional keys | Expand Create a data source — response body — object data source properties value |
Referenced models: Create a data source — response body — object data source properties value
Create a database — request body — body icon
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | Model | Alternative | Expand Create a database — request body — body icon File Upload |
$ (oneOf 2) | Model | Alternative | Expand Create a database — request body — body icon Emoji |
$ (oneOf 3) | Model | Alternative | Expand Create a database — request body — body icon External |
$ (oneOf 4) | Model | Alternative | Expand Create a database — request body — body icon Custom Emoji |
$ (oneOf 5) | Model | Alternative | Expand Create a database — request body — body icon Icon |
Referenced models: Create a database — request body — body icon Custom Emoji, Create a database — request body — body icon Emoji, Create a database — request body — body icon External, Create a database — request body — body icon File Upload, Create a database — request body — body icon Icon
Create a data source — request body — body parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
database_id | string | Required within parent | The ID of the parent database (with or without dashes), for example, 195de9221179449fab8075a27c979105 |
type | string | Optional | Always `database_id` Must equal: database_id |
List views — response body — view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: notion.create_a_database. Catalog operation: create_a_database. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"Notion-Version": "2026-03-11"}