Idea Organiser
Idea Organiser · GPT-Aktionen
IdeaOrganiser
Support the user by managing notes in Notion. You can search for titles, create and read (CR) comments, create, read and update (CRU) databases and pages, and create, read, update and delete (CRUD) blocks.
GET /v1/blocksgetBlocksRetrieve a block.
PUT /v1/blocksputBlocksUpdate a block.
DELETE /v1/blocksdeleteBlocksDelete a block.
PUT /v1/blocks/childrenputBlocksChildrenAppend block children.
GET /v1/blocks/childrengetBlocksChildrenRetrieve block children.
POST /v1/pagespostPagesCreate a page. `additionalProperties` is a variable key. If it is of type `object[]` of `content`, it is an array of block objects. Otherwise the `object[]` type is an array of rich text objects. `object` type is `{}`. `any` type is `null`.
GET /v1/pagesgetPagesRetrieve a page. If `page_id` is missing, Search with `postSearch` without `query`.
PUT /v1/pagesputPagesUpdate page properties. The `property` values to update for the page. Update with the same property name.
GET /v1/pages/propertiesgetPagesPropertiesRetrieve a page property item.
POST /v1/databasespostDatabasesCreate a database. `additionalProperties` is a variable key. An `object[]` type is an array of rich text objects. `object` type is `{}`.
GET /v1/databasesgetDatabasesRetrieve a database.
PUT /v1/databasesputDatabasesUpdate a database. The `property` values to update for the database . Update with the same property name.
POST /v1/databases/querypostDatabasesQueryQuery a database.
POST /v1/commentspostCommentsCreate comment. An `object[]` represents an array of rich text objects.
GET /v1/commentsgetCommentsRetrieve comments.
POST /v1/searchpostSearchSearch by title. database_id and page_id can be retrieved.
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "IdeaOrganiser",
"version": "1.0.0",
"description": "Support the user by managing notes in Notion. You can search for titles, create and read (CR) comments, create, read and update (CRU) databases and pages, and create, read, update and delete (CRUD) blocks."
},
"servers": [
{
"url": "https://idea-organiser.inu-ai.com"
}
],
"paths": {
"/v1/blocks": {
"get": {
"operationId": "getBlocks",
"x-openai-isConsequential": false,
"description": "Retrieve a block.",
"parameters": [
{
"name": "block_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK."
}
}
},
"put": {
"operationId": "putBlocks",
"x-openai-isConsequential": false,
"description": "Update a block.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"block_id",
"block"
],
"properties": {
"block_id": {
"type": "string"
},
"block": {
"type": "string",
"description": "Markdown and GitHub flavored Markdown. mermaid etc."
},
"archived": {
"type": "boolean"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
},
"delete": {
"operationId": "deleteBlocks",
"x-openai-isConsequential": false,
"description": "Delete a block.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"block_id"
],
"properties": {
"block_id": {
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/blocks/children": {
"put": {
"operationId": "putBlocksChildren",
"x-openai-isConsequential": false,
"description": "Append block children.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"block_id",
"children"
],
"properties": {
"block_id": {
"description": "block_id is page_id.",
"type": "string"
},
"children": {
"description": "Markdown and GitHub flavored Markdown. mermaid etc.",
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
},
"get": {
"operationId": "getBlocksChildren",
"x-openai-isConsequential": false,
"description": "Retrieve block children.",
"parameters": [
{
"name": "block_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"description": "1 to 100.",
"in": "query",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "include_ids",
"description": "Whether to include block_id in response.",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/pages": {
"post": {
"operationId": "postPages",
"x-openai-isConsequential": false,
"description": "Create a page. `additionalProperties` is a variable key. If it is of type `object[]` of `content`, it is an array of block objects. Otherwise the `object[]` type is an array of rich text objects. `object` type is `{}`. `any` type is `null`.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"description": "The properties of the parent database are equal to the properties of the child pages.",
"oneOf": [
{
"type": "object",
"properties": {
"parent": {
"oneOf": [
{
"type": "object",
"properties": {
"database_id": {
"type": "string",
"format": "uuid"
}
}
},
{
"type": "object",
"properties": {
"page_id": {
"type": "string",
"format": "uuid"
}
}
}
]
},
"properties": {
"oneOf": [
{
"type": "object",
"properties": {
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/RichTextOmission"
}
}
},
{
"type": "object",
"properties": {
"rich_text": {
"$ref": "#/components/schemas/RichTextOmission"
}
}
},
{
"type": "object",
"properties": {
"number": {
"oneOf": [
{
"type": "integer"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"url": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"select": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name?": {
"type": "string"
},
"color?": {
"type": "string",
"enum": [
"brown",
"orange",
"yellow",
"green",
"blue",
"purple",
"pink",
"red"
]
}
}
},
{
"type": "object",
"properties": {
"id?": {
"type": "string"
},
"name": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"multi_select": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
}
]
}
}
}
},
{
"type": "object",
"properties": {
"people": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"person": {
"type": "object",
"properties": {
"email?": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"name?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"bot": {
"oneOf": [
{
"type": "object",
"properties": {
":": {
"type": "object"
}
}
},
{
"type": "object",
"properties": {
"owner": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user"
]
},
"user": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"person"
]
},
"person": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"user"
]
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"user"
]
}
}
}
]
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workspace"
]
},
"workspace": {
"type": "boolean",
"enum": [
true
]
}
}
}
]
},
"workspace_name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
}
]
},
"id": {
"type": "string"
},
"name?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
}
]
}
}
}
},
{
"type": "object",
"properties": {
"email": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"phone_number": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"date": {
"oneOf": [
{
"type": "object",
"properties": {
"start": {
"type": "string"
},
"end?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"time_zone?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"checkbox": {
"type": "boolean"
}
}
},
{
"type": "object",
"properties": {
"relation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"expiry_time?": {
"type": "string"
}
}
},
"name": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
"name": {
"type": "string"
}
}
}
]
}
}
}
},
{
"type": "object",
"properties": {
"status": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"nullable": true
}
]
}
}
}
]
}
}
},
{
"type": "object",
"properties": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/components/schemas/RichTextOmission"
},
{
"type": "integer"
},
{
"nullable": true
},
{
"type": "string"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id?": {
"type": "string"
},
"color?": {
"type": "string"
}
}
}
]
}
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"person": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"name?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"object?": {
"type": "string",
"enum": [
"user"
]
}
}
},
{
"type": "object",
"properties": {
"bot": {
"oneOf": [
{
"type": "object",
"properties": {
":": {
"type": "object"
}
}
},
{
"type": "object",
"properties": {
"owner": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user"
]
},
"user": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"person"
]
},
"person": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"user"
]
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"user"
]
}
}
}
]
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workspace"
]
},
"workspace": {
"type": "boolean",
"enum": [
true
]
}
}
}
]
},
"workspace_name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
}
]
},
"id": {
"type": "string"
},
"name?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"object?": {
"type": "string",
"enum": [
"user"
]
}
}
}
]
}
},
{
"type": "object",
"properties": {
"start": {
"type": "string"
},
"end?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"timezone?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"expiry_time?": {
"type": "string"
}
}
},
"name": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
"name": {
"type": "string"
}
}
}
]
}
}
]
}
}
}
]
},
"icon?": {
"oneOf": [
{
"type": "object",
"properties": {
"emoji": {
"type": "string"
}
}
},
{
"nullable": true
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
}
]
},
"cover?": {
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
},
"children?": {
"type": "string"
},
"content?": {
"type": "array",
"items": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"parent": {
"type": "object",
"properties": {
"database_id": {
"type": "string",
"format": "uuid"
}
}
},
"properties": {
"type": "object",
"properties": {
"title?": {
"oneOf": [
{
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/RichTextOmission"
}
}
},
{
"$ref": "#/components/schemas/RichTextOmission"
}
]
}
}
},
"icon?": {
"oneOf": [
{
"type": "object",
"properties": {
"emoji": {
"type": "string"
}
}
},
{
"nullable": true
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
}
]
},
"cover?": {
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
},
"children?": {
"type": "string"
}
}
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response"
}
}
},
"get": {
"operationId": "getPages",
"x-openai-isConsequential": false,
"description": "Retrieve a page. If `page_id` is missing, Search with `postSearch` without `query`.",
"parameters": [
{
"name": "page_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "include_ids",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK."
}
}
},
"put": {
"operationId": "putPages",
"x-openai-isConsequential": false,
"description": "Update page properties. The `property` values to update for the page. Update with the same property name.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page_id"
],
"properties": {
"page_id": {
"type": "string"
},
"properties": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
},
"archived": {
"type": "boolean"
},
"icon": {
"oneOf": [
{
"type": "object",
"properties": {
"emoji": {
"type": "string"
}
}
},
{
"nullable": true
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
}
]
},
"cover": {
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/pages/properties": {
"get": {
"operationId": "getPagesProperties",
"x-openai-isConsequential": false,
"description": "Retrieve a page property item.",
"parameters": [
{
"name": "page_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "property_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"description": "1 to 4.",
"in": "query",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "start_cursor",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/databases": {
"post": {
"operationId": "postDatabases",
"x-openai-isConsequential": false,
"description": "Create a database. `additionalProperties` is a variable key. An `object[]` type is an array of rich text objects. `object` type is `{}`.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"database"
],
"properties": {
"database": {
"type": "object",
"required": [
"parent",
"properties"
],
"properties": {
"parent": {
"type": "object",
"properties": {
"page_id": {
"type": "string"
}
}
},
"properties": {
"type": "object",
"properties": {
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"number": {
"type": "object",
"properties": {
"format?": {
"$ref": "#/components/schemas/NumberFormat"
}
}
}
}
},
{
"type": "object",
"properties": {
"formula": {
"type": "object",
"properties": {
"expression?": {
"type": "string"
}
}
}
}
},
{
"type": "object",
"properties": {
"select": {
"type": "object",
"properties": {
"options?": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color?": {
"type": "string"
}
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"multi_select": {
"type": "object",
"properties": {
"options?": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color?": {
"type": "string"
}
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"status": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"relation": {
"oneOf": [
{
"type": "object",
"properties": {
"single_property": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
},
"database_id": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"dual_property": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
},
"database_id": {
"type": "string"
}
}
}
]
}
}
},
{
"type": "object",
"properties": {
"rollup": {
"oneOf": [
{
"type": "object",
"properties": {
"rollup_property_name": {
"type": "string"
},
"relation_property_name": {
"type": "string"
},
"function": {
"$ref": "#/components/schemas/RollupFunction"
},
"rollup_property_id?": {
"type": "string"
},
"relation_property_id?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"rollup_property_name": {
"type": "string"
},
"relation_property_id": {
"type": "string"
},
"function": {
"type": "string"
},
"relation_property_name?": {
"type": "string"
},
"rollup_property_id?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"relation_property_name": {
"type": "string"
},
"rollup_property_id": {
"type": "string"
},
"function": {
"type": "string"
},
"rollup_property_name?": {
"type": "string"
},
"relation_property_id?": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"rollup_property_id": {
"type": "string"
},
"relation_property_id": {
"type": "string"
},
"function": {
"type": "string"
},
"rollup_property_name?": {
"type": "string"
},
"relation_property_name?": {
"type": "string"
}
}
}
]
}
}
},
{
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"rich_text": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"url": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"people": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"files": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"email": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"phone_number": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"date": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"checkbox": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"created_by": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"created_time": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"last_edited_by": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"properties": {
"last_edited_time": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
}
]
}
}
},
"icon?": {
"oneOf": [
{
"type": "object",
"properties": {
"emoji": {
"type": "string"
}
}
},
{
"nullable": true
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
}
]
},
"cover?": {
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
},
"title?": {
"$ref": "#/components/schemas/RichTextOmission"
},
"description?": {
"$ref": "#/components/schemas/RichTextOmission"
},
"is_inline?": {
"type": "boolean"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
},
"get": {
"operationId": "getDatabases",
"x-openai-isConsequential": false,
"description": "Retrieve a database.",
"parameters": [
{
"name": "database_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK."
}
}
},
"put": {
"operationId": "putDatabases",
"x-openai-isConsequential": false,
"description": "Update a database. The `property` values to update for the database . Update with the same property name.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"database_id"
],
"properties": {
"database_id": {
"type": "string"
},
"title": {
"$ref": "#/components/schemas/RichTextOmission"
},
"description": {
"$ref": "#/components/schemas/RichTextOmission"
},
"icon": {
"oneOf": [
{
"type": "object",
"properties": {
"emoji": {
"type": "string"
}
}
},
{
"nullable": true
},
{
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
}
]
},
"cover": {
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
}
},
"properties": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/databases/query": {
"post": {
"operationId": "postDatabasesQuery",
"x-openai-isConsequential": false,
"description": "Query a database.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"database_id",
"page_size"
],
"properties": {
"database_id": {
"type": "string"
},
"filter_properties": {
"type": "array",
"items": {
"type": "string"
}
},
"sorts": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"property": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
}
},
{
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"enum": [
"created_time",
"last_edited_time"
]
},
"direction": {
"type": "string",
"enum": [
"ascending",
"descending"
]
}
}
}
]
}
},
"filter": {
"oneOf": [
{
"type": "object",
"properties": {
"or": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object"
}
]
}
}
}
},
{
"type": "object",
"properties": {
"and": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object"
}
]
}
}
}
},
{
"type": "object",
"properties": {
"PropertyFilter": {
"type": "object"
}
}
},
{
"type": "object",
"properties": {
"TimestampCreatedTimeFilter": {
"type": "object"
}
}
},
{
"type": "object",
"properties": {
"TimestampLastEditedTimeFilter": {
"type": "object"
}
}
}
]
},
"page_size": {
"type": "integer",
"description": "1 to 4."
},
"start_cursor": {
"type": "string"
},
"archived": {
"type": "boolean"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/comments": {
"post": {
"operationId": "postComments",
"x-openai-isConsequential": false,
"description": "Create comment. An `object[]` represents an array of rich text objects.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"comment"
],
"properties": {
"comment": {
"oneOf": [
{
"type": "object",
"required": [
"parent",
"rich_text"
],
"properties": {
"parent": {
"type": "object",
"properties": {
"page_id": {
"type": "string"
}
}
},
"rich_text": {
"$ref": "#/components/schemas/RichTextOmission"
}
}
},
{
"type": "object",
"required": [
"discussion_id",
"rich_text"
],
"properties": {
"discussion_id": {
"type": "string"
},
"rich_text": {
"$ref": "#/components/schemas/RichTextOmission"
}
}
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
},
"get": {
"operationId": "getComments",
"x-openai-isConsequential": false,
"description": "Retrieve comments.",
"parameters": [
{
"name": "block_id",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "page_size",
"description": "1 to 4.",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK."
}
}
}
},
"/v1/search": {
"post": {
"operationId": "postSearch",
"x-openai-isConsequential": false,
"description": "Search by title. database_id and page_id can be retrieved.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page_size"
],
"properties": {
"query": {
"type": "string"
},
"sort": {
"type": "object",
"required": [
"direction",
"timestamp"
],
"properties": {
"direction": {
"type": "string",
"enum": [
"ascending",
"descending"
]
},
"timestamp": {
"type": "string",
"enum": [
"last_edited_time"
]
}
}
},
"filter": {
"type": "object",
"required": [
"property",
"value"
],
"properties": {
"property": {
"type": "string",
"enum": [
"object"
]
},
"value": {
"type": "string",
"enum": [
"page",
"database"
]
}
}
},
"start_cursor": {
"type": "string"
},
"page_size": {
"type": "integer",
"description": "1 to 4."
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK."
}
}
}
}
},
"components": {
"schemas": {
"RichText": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "object",
"required": [
"content"
],
"properties": {
"content": {
"type": "string"
},
"link?": {
"type": "object",
"properties": {
"url": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
}
}
},
"annotations?": {
"type": "object",
"properties": {
"bold?": {
"type": "boolean"
},
"italic?": {
"type": "boolean"
},
"strikethrough?": {
"type": "boolean"
},
"underline?": {
"type": "boolean"
},
"code?": {
"type": "boolean"
},
"color?": {
"type": "string",
"enum": [
"default",
"gray",
"brown",
"orange",
"yellow",
"green",
"blue",
"purple",
"pink",
"red",
"gray_background",
"brown_background",
"orange_background",
"yellow_background",
"green_background",
"blue_background",
"purple_background",
"pink_background",
"red_background"
]
}
}
}
}
},
{
"type": "object",
"required": [
"mention"
],
"properties": {
"mention": {
"type": "object",
"properties": {
"user": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"person": {
"type": "object",
"properties": {
"email?": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"name?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"bot": {
"oneOf": [
{
"type": "object",
"properties": {
":": {
"type": "object"
}
}
},
{
"type": "object",
"properties": {
"owner": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user"
]
},
"user": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"person"
]
},
"person": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"user"
]
}
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"enum": [
"user"
]
}
}
}
]
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"workspace"
]
},
"workspace": {
"type": "boolean",
"enum": [
true
]
}
}
}
]
},
"workspace_name": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
}
]
},
"id": {
"type": "string"
},
"name?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"avatar_url?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"start": {
"type": "string"
},
"end?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
},
"time_zone?": {
"oneOf": [
{
"type": "string"
},
{
"nullable": true
}
]
}
}
},
{
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
},
{
"type": "object",
"properties": {
"database": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
},
{
"type": "object",
"properties": {
"template_mention": {
"oneOf": [
{
"type": "object",
"properties": {
"template_mention_date": {
"type": "string",
"enum": [
"today",
"now"
]
}
}
},
{
"type": "object",
"properties": {
"template_mention_user": {
"type": "string",
"enum": [
"me"
]
}
}
}
]
}
}
}
]
}
}
},
"annotations?": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
},
{
"type": "object",
"required": [
"equation"
],
"properties": {
"equation": {
"type": "object",
"properties": {
"expression": {
"type": "string"
}
}
},
"annotations?": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
}
}
]
}
},
"RichTextOmission": {
"type": "array",
"items": {
"type": "object",
"properties": {
":": {
"type": "object"
}
}
}
},
"Language": {
"type": "string",
"default": "python",
"enum": [
"abap",
"agda",
"arduino",
"assembly",
"bash",
"basic",
"bnf",
"c",
"c#",
"c++",
"clojure",
"coffeescript",
"coq",
"css",
"dart",
"dhall",
"diff",
"docker",
"ebnf",
"elixir",
"elm",
"erlang",
"f#",
"flow",
"fortran",
"gherkin",
"glsl",
"go",
"graphql",
"groovy",
"haskell",
"html",
"idris",
"java",
"javascript",
"json",
"julia",
"kotlin",
"latex",
"less",
"lisp",
"livescript",
"llvm ir",
"lua",
"makefile",
"markdown",
"markup",
"matlab",
"mathematica",
"mermaid",
"nix",
"objective-c",
"ocaml",
"pascal",
"perl",
"php",
"plain text",
"powershell",
"prolog",
"protobuf",
"purescript",
"python",
"r",
"racket",
"reason",
"ruby",
"rust",
"sass",
"scala",
"scheme",
"scss",
"shell",
"solidity",
"sql",
"swift",
"toml",
"typescript",
"vb.net",
"verilog",
"vhdl",
"visual basic",
"webassembly",
"xml",
"yaml",
"java/c/c++/c#"
]
},
"NumberFormat": {
"type": "string",
"enum": [
"number",
"number_with_commas",
"percent",
"dollar",
"canadian_dollar",
"singapore_dollar",
"euro",
"pound",
"yen",
"ruble",
"rupee",
"won",
"yuan",
"real",
"lira",
"rupiah",
"franc",
"hong_kong_dollar",
"new_zealand_dollar",
"krona",
"norwegian_krone",
"mexican_peso",
"rand",
"new_taiwan_dollar",
"danish_krone",
"zloty",
"baht",
"forint",
"koruna",
"shekel",
"chilean_peso",
"philippine_peso",
"dirham",
"colombian_peso",
"riyal",
"ringgit",
"leu",
"argentine_peso",
"uruguayan_peso",
"peruvian_sol"
]
},
"RollupFunction": {
"type": "string",
"enum": [
"count",
"count_values",
"empty",
"not_empty",
"unique",
"show_unique",
"percent_empty",
"percent_not_empty",
"sum",
"average",
"median",
"min",
"max",
"range",
"earliest_date",
"latest_date",
"date_range",
"checked",
"unchecked",
"percent_checked",
"percent_unchecked",
"count_per_group",
"percent_per_group",
"show_original"
]
}
}
}
}