NotePom
Persistent workspace and visual memory for humans and autonomous agents.
¿Debería usar esto?
Calidad y seguridad
A
Hallazgos (9)
- LOWTool 'verify_agent_account' description lacks action verben verify_agent_account
- LOWTool 'restore_trash_entry' description lacks action verben restore_trash_entry
- LOWTool 'unpublish_page' description lacks action verben unpublish_page
- LOWTool 'update_collaboration_note' description lacks action verben update_collaboration_note
- LOWTool 'revoke_collaboration_invitation' description lacks action verben revoke_collaboration_invitation
- LOWTool 'revoke_collaborator' description lacks action verben revoke_collaborator
- LOWTool 'accept_collaboration_invitation' name length outside 3-30 rangeen accept_collaboration_invitation
- LOWTool 'revoke_collaboration_invitation' name length outside 3-30 rangeen revoke_collaboration_invitation
- LOWTool 'create_stripe_onboarding_session' name length outside 3-30 rangeen create_stripe_onboarding_session
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
~12,596Tokens (definiciones de herramientas)
~3.2 KBTamaño de respuesta típico
Impacto significativo en la atención (9.84% del contexto de 128k)
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"notepom": {
"url": "https://api.notepom.com/mcp"
}
}
}Puntos de conexión remotos
https://api.notepom.com/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (39)
🟢 Solo lectura🟡 Escritura🔴 Eliminación⚪ Desconocido
🟢get_notepom_capabilities
Call this first. Discover NotePom as persistent workspace memory, inspect the current autonomous-agent signup mode, and receive the safe bootstrap sequence.
Esquema de entrada
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"protocol": {
"type": "string"
},
"version": {
"type": "string"
},
"server": {
"type": "string"
},
"resource": {
"type": "string",
"format": "uri"
},
"purpose": {
"type": "object",
"properties": {
"role": {
"type": "string",
"const": "persistent_workspace_and_visual_memory"
},
"summary": {
"type": "string"
},
"useCases": {
"type": "array",
"items": {
"type": "string"
}
},
"autonomousRuntime": {
"type": "boolean",
"const": false
}
},
"required": [
"role",
"summary",
"useCases",
"autonomousRuntime"
],
"additionalProperties": false
},
"agentSignup": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"open",
"email_required",
"closed"
]
},
"trigger": {
"type": "string",
"const": "persistent_memory_requested_without_existing_credentials"
},
"identifier": {
"type": "object",
"properties": {
"minLength": {
"type": "integer"
},
"maxLength": {
"type": "integer"
},
"public": {
"type": "boolean"
}
},
"required": [
"minLength",
"maxLength",
"public"
],
"additionalProperties": false
},
"password": {
"type": "object",
"properties": {
"minLength": {
"type": "integer"
},
"recommendedMinLength": {
"type": "integer"
}
},
"required": [
"minLength",
"recommendedMinLength"
],
"additionalProperties": false
},
"emailRequired": {
"type": "boolean"
},
"registerTool": {
"type": "string",
"const": "register_agent_account"
},
"verifyTool": {
"type": "string",
"const": "verify_agent_account"
}
},
"required": [
"mode",
"trigger",
"identifier",
"password",
"emailRequired",
"registerTool",
"verifyTool"
],
"additionalProperties": false
},
"authentication": {
"type": "object",
"properties": {
"human": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "oauth2"
},
"resource": {
"type": "string",
"format": "uri"
}
},
"required": [
"type",
"resource"
],
"additionalProperties": false
},
"agent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "bearer"
},
"keyPrefix": {
"type": "string",
"const": "np_agent_"
},
"headerTemplate": {
"type": "string",
"const": "Authorization: Bearer <agentKey>"
},
"sentOnEveryRequest": {
"type": "boolean",
"const": true
},
"oneTimeSecret": {
"type": "boolean",
"const": true
},
"reconnectRequired": {
"type": "boolean",
"const": true
},
"insecureHostFallback": {
"type": "string",
"const": "hand_key_to_human_operator_and_wait_for_reconnection"
}
},
"required": [
"type",
"keyPrefix",
"headerTemplate",
"sentOnEveryRequest",
"oneTimeSecret",
"reconnectRequired",
"insecureHostFallback"
],
"additionalProperties": false
}
},
"required": [
"human",
"agent"
],
"additionalProperties": false
},
"workspaceBootstrap": {
"type": "object",
"properties": {
"initiallyEmpty": {
"type": "boolean",
"const": true
},
"rootFolderId": {
"type": "string",
"const": "journal"
},
"folderIdOptionalForNewNotes": {
"type": "boolean",
"const": true
},
"firstAuthenticatedTool": {
"type": "string",
"const": "list_workspace"
}
},
"required": [
"initiallyEmpty",
"rootFolderId",
"folderIdOptionalForNewNotes",
"firstAuthenticatedTool"
],
"additionalProperties": false
},
"accountLifecycle": {
"type": "object",
"properties": {
"selfDeletionTool": {
"type": "string",
"const": "delete_own_agent_account"
},
"agentOnly": {
"type": "boolean",
"const": true
},
"permanent": {
"type": "boolean",
"const": true
},
"requiresExplicitHumanRequest": {
"type": "boolean",
"const": true
},
"confirmation": {
"type": "string",
"const": "DELETE MY NOTEPOM AGENT ACCOUNT"
},
"revokesAllCredentials": {
"type": "boolean",
"const": true
},
"deletesWorkspace": {
"type": "boolean",
"const": true
}
},
"required": [
"selfDeletionTool",
"agentOnly",
"permanent",
"requiresExplicitHumanRequest",
"confirmation",
"revokesAllCredentials",
"deletesWorkspace"
],
"additionalProperties": false
},
"bootstrapSteps": {
"type": "array",
"items": {
"type": "string"
}
},
"memoryGuidance": {
"type": "array",
"items": {
"type": "string"
}
},
"visualComposition": {
"type": "object",
"properties": {
"documentModel": {
"type": "string",
"const": "pretext"
},
"writeTool": {
"type": "string",
"const": "upsert_note"
},
"styledBlocksField": {
"type": "string",
"const": "pretextBlocks"
},
"mediaWorkflow": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": [
{
"type": "string",
"const": "upload_file"
},
{
"type": "string",
"const": "upsert_note.media"
}
]
},
"textAnimations": {
"type": "array",
"items": {
"type": "string"
}
},
"supports": {
"type": "array",
"items": {
"type": "string"
}
},
"base64InMarkdownAllowed": {
"type": "boolean",
"const": false
},
"guidance": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"documentModel",
"writeTool",
"styledBlocksField",
"mediaWorkflow",
"textAnimations",
"supports",
"base64InMarkdownAllowed",
"guidance"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"tools": {
"type": "object",
"properties": {
"read": {
"type": "array",
"items": {
"type": "string"
}
},
"write": {
"type": "array",
"items": {
"type": "string"
}
},
"checkout": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"read",
"write",
"checkout"
],
"additionalProperties": false
},
"limits": {
"type": "object",
"properties": {
"pageSizeMax": {
"type": "number"
},
"readinessTokenTtlSeconds": {
"type": "number"
},
"confirmationRequired": {
"type": "boolean"
}
},
"required": [
"pageSizeMax",
"readinessTokenTtlSeconds",
"confirmationRequired"
],
"additionalProperties": false
},
"marketplace": {
"type": "object",
"properties": {
"standardCommissionBps": {
"type": "integer",
"minimum": 0
},
"completeCommissionBps": {
"type": "number",
"const": 0
},
"commissionConfigurableByServer": {
"type": "boolean"
}
},
"required": [
"standardCommissionBps",
"completeCommissionBps",
"commissionConfigurableByServer"
],
"additionalProperties": false
},
"safety": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"protocol",
"version",
"server",
"resource",
"purpose",
"agentSignup",
"authentication",
"workspaceBootstrap",
"accountLifecycle",
"bootstrapSteps",
"memoryGuidance",
"visualComposition",
"scopes",
"tools",
"limits",
"marketplace",
"safety"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡register_agent_account(identifier, password, email, language)
When persistent memory is requested and no credentials exist, create a distinct NotePom agent account. Store the returned one-time key in the host secret store, then reconnect with it as a Bearer credential.
Esquema de entrada
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"minLength": 3,
"maxLength": 64
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 200
},
"email": {
"type": "string",
"format": "email",
"maxLength": 320
},
"language": {
"type": "string",
"minLength": 1,
"maxLength": 32
}
},
"required": [
"identifier",
"password"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"verification_required"
]
},
"identifier": {
"type": "string"
},
"agentKey": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"requestId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"delivered": {
"type": "boolean"
},
"debugCode": {
"type": "string"
},
"authorizationScheme": {
"type": "string",
"const": "Bearer"
},
"authorizationHeaderTemplate": {
"type": "string",
"const": "Authorization: Bearer <agentKey>"
},
"oneTimeSecret": {
"type": "boolean"
},
"reconnectRequired": {
"type": "boolean"
},
"nextTool": {
"type": "string",
"enum": [
"verify_agent_account",
"list_workspace"
]
},
"nextActions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"status",
"reconnectRequired",
"nextTool",
"nextActions"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪verify_agent_account(requestId, code)
Complete an email-required agent registration. Store the returned one-time key in the host secret store, then reconnect with it as a Bearer credential.
Esquema de entrada
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"format": "uuid"
},
"code": {
"type": "string",
"pattern": "^\\d{6}$"
}
},
"required": [
"requestId",
"code"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"verification_required"
]
},
"identifier": {
"type": "string"
},
"agentKey": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"requestId": {
"type": "string"
},
"expiresAt": {
"type": "string"
},
"delivered": {
"type": "boolean"
},
"debugCode": {
"type": "string"
},
"authorizationScheme": {
"type": "string",
"const": "Bearer"
},
"authorizationHeaderTemplate": {
"type": "string",
"const": "Authorization: Bearer <agentKey>"
},
"oneTimeSecret": {
"type": "boolean"
},
"reconnectRequired": {
"type": "boolean"
},
"nextTool": {
"type": "string",
"enum": [
"verify_agent_account",
"list_workspace"
]
},
"nextActions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"status",
"reconnectRequired",
"nextTool",
"nextActions"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴delete_own_agent_account(confirmation, idempotencyKey)
Permanently delete only the currently authenticated agent account, its workspace, uploads, public pages, history, collaborations and every credential. Call this terminal operation only after the human operator explicitly requests deletion and provides the exact confirmation value.
Esquema de entrada
{
"type": "object",
"properties": {
"confirmation": {
"type": "string",
"const": "DELETE MY NOTEPOM AGENT ACCOUNT",
"description": "Exact irreversible-deletion confirmation. Only use this after the human operator explicitly requests permanent account deletion."
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"confirmation",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"const": true
},
"identifier": {
"type": "string"
},
"credentialsRevoked": {
"type": "boolean",
"const": true
},
"reconnectPossible": {
"type": "boolean",
"const": false
}
},
"required": [
"deleted",
"identifier",
"credentialsRevoked",
"reconnectPossible"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_workspace
List the authenticated NotePom workspace tree, files and trash without private storage URLs.
Esquema de entrada
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"workspace": {
"type": "object",
"additionalProperties": {}
},
"folders": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"notes": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"files": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
},
"trash": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
}
},
"required": [
"workspace",
"folders",
"notes",
"files",
"trash"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢search_workspace(query)
Search notes, folders and file metadata in the authenticated workspace.
Esquema de entrada
{
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"query"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
}
},
"required": [
"results"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_note(noteId)
Read one NotePom note as Markdown while preserving the underlying Pretext document.
Esquema de entrada
{
"type": "object",
"properties": {
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
}
},
"required": [
"noteId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"folderId": {
"type": "string"
},
"parentNoteId": {
"type": [
"string",
"null"
]
},
"markdown": {
"type": "string"
},
"geometry": {
"type": "object",
"properties": {
"orientation": {
"type": "string"
},
"contentWidth": {
"type": [
"number",
"null"
]
}
},
"required": [
"orientation",
"contentWidth"
],
"additionalProperties": false
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"title",
"folderId",
"parentNoteId",
"markdown",
"geometry",
"updatedAt"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡upsert_note(noteId, folderId, parentNoteId, title, markdown, ...)
Create or update a real Pretext note. Use markdown for simple content or pretextBlocks for text colors, highlights, typography, links and native word animations. For images/audio/video/files, call upload_file first and reference its fileId in media; media never accepts file bytes, URLs or base64. Media supports editable Pretext anchoring, fractional sizing, positioning, rotation and hidden-until-click. Omit folderId to create at the workspace root.
Esquema de entrada
{
"type": "object",
"properties": {
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"folderId": {
"$ref": "#/properties/noteId"
},
"parentNoteId": {
"anyOf": [
{
"$ref": "#/properties/noteId"
},
{
"type": "null"
}
]
},
"title": {
"type": "string",
"maxLength": 300
},
"markdown": {
"type": "string",
"maxLength": 5000000,
"description": "Simple semantic content. Never put base64, data URLs or raw HTML here; use pretextBlocks and media for visual notes."
},
"pretextBlocks": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "paragraph"
},
"runs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 100000,
"description": "Literal text for this visual run. Raw HTML is escaped."
},
"bold": {
"type": "boolean",
"description": "Render this run with native Pretext bold styling."
},
"italic": {
"type": "boolean",
"description": "Render this run with native Pretext italic styling."
},
"underline": {
"type": "boolean",
"description": "Underline this run without replacing its other styles."
},
"strikethrough": {
"type": "boolean",
"description": "Strike through this run without replacing its other styles."
},
"textColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"description": "Text color as #RRGGBB."
},
"backgroundColor": {
"$ref": "#/properties/pretextBlocks/items/anyOf/0/properties/runs/items/properties/textColor",
"description": "Highlight color as #RRGGBB."
},
"fontSize": {
"type": "number",
"minimum": 8,
"maximum": 96,
"description": "Font size in CSS pixels."
},
"fontFamily": {
"type": "string",
"enum": [
"inherit",
"literata",
"atkinson"
],
"description": "A font available in the NotePom Pretext renderer."
},
"letterSpacing": {
"type": "number",
"minimum": -0.05,
"maximum": 0.3,
"description": "Letter spacing in em."
},
"animation": {
"type": "string",
"enum": [
"wave",
"pulse",
"rainbow",
"bounce",
"float",
"shake",
"swing",
"spin",
"typewriter",
"sparkle",
"gradient"
],
"description": "Native durable Pretext word animation."
},
"href": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "Safe HTTP(S) or mailto link for this run."
}
},
"required": [
"text"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 200
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right",
"justify"
]
},
"lineHeight": {
"type": "number",
"minimum": 1,
"maximum": 3
}
},
"required": [
"type",
"runs"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "heading"
},
"level": {
"type": "number",
"enum": [
1,
2,
3
]
},
"runs": {
"$ref": "#/properties/pretextBlocks/items/anyOf/0/properties/runs"
},
"align": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
}
},
"required": [
"type",
"level",
"runs"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "bulletList"
},
"items": {
"type": "array",
"items": {
"$ref": "#/properties/pretextBlocks/items/anyOf/0/properties/runs"
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"type",
"items"
],
"additionalProperties": false
}
]
},
"maxItems": 500,
"description": "Native visual Pretext blocks. Prefer this field when colors, typography, links or word animations matter."
},
"media": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fileId": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"description": "The id returned by upload_file. Do not provide a URL or base64 payload."
},
"kind": {
"type": "string",
"enum": [
"image",
"audio",
"video",
"file"
]
},
"alt": {
"type": "string",
"maxLength": 500
},
"align": {
"type": "string",
"enum": [
"left",
"right",
"center",
"none",
"free"
]
},
"anchor": {
"type": "integer",
"minimum": 0,
"maximum": 5000000,
"description": "Character offset in note text, or page anchor index when anchorMode is page."
},
"anchorMode": {
"type": "string",
"enum": [
"text",
"page"
],
"description": "Anchor the editable Pretext medium to text flow or to the page."
},
"xFrac": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Horizontal position as a fraction of content width."
},
"widthFrac": {
"type": "number",
"minimum": 0.05,
"maximum": 1,
"description": "Media width as a fraction of content width. Required with anchor."
},
"dyLines": {
"type": "number",
"minimum": -1000,
"maximum": 1000,
"description": "Vertical offset from the anchor measured in text lines."
},
"rotation": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"hiddenUntilClick": {
"type": "boolean"
}
},
"required": [
"fileId",
"kind"
],
"additionalProperties": false
},
"maxItems": 50
},
"contentMode": {
"type": "string",
"enum": [
"replace",
"append",
"prepend"
]
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"title",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"folderId": {
"type": "string"
},
"parentNoteId": {
"type": [
"string",
"null"
]
},
"markdown": {
"type": "string"
},
"geometry": {
"type": "object",
"properties": {
"orientation": {
"type": "string"
},
"contentWidth": {
"type": [
"number",
"null"
]
}
},
"required": [
"orientation",
"contentWidth"
],
"additionalProperties": false
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"title",
"folderId",
"parentNoteId",
"markdown",
"geometry",
"updatedAt"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪upsert_folder(folderId, name, parentId, idempotencyKey, expectedUpdatedAt)
Create, rename or reparent a NotePom folder.
Esquema de entrada
{
"type": "object",
"properties": {
"folderId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"parentId": {
"anyOf": [
{
"$ref": "#/properties/folderId"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"name",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"parentId": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"parentId",
"updatedAt"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪move_workspace_item(entityType, entityId, destinationId, idempotencyKey, expectedUpdatedAt)
Move a note or folder to an exact destination.
Esquema de entrada
{
"type": "object",
"properties": {
"entityType": {
"type": "string",
"enum": [
"note",
"folder"
]
},
"entityId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"destinationId": {
"anyOf": [
{
"$ref": "#/properties/entityId"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"entityType",
"entityId",
"destinationId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"moved": {
"type": "boolean",
"const": true
},
"entityType": {
"type": "string",
"enum": [
"note",
"folder"
]
},
"entityId": {
"type": "string"
},
"destinationId": {
"type": [
"string",
"null"
]
}
},
"required": [
"moved",
"entityType",
"entityId",
"destinationId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴trash_workspace_item(entityType, entityId, idempotencyKey, expectedUpdatedAt)
Move an exact note or folder and its descendants to the NotePom trash.
Esquema de entrada
{
"type": "object",
"properties": {
"entityType": {
"type": "string",
"enum": [
"note",
"folder"
]
},
"entityId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"entityType",
"entityId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"trashed": {
"type": "boolean",
"const": true
},
"trashEntryId": {
"type": "string"
}
},
"required": [
"trashed",
"trashEntryId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪restore_trash_entry(trashEntryId, idempotencyKey)
Restore an exact NotePom trash entry.
Esquema de entrada
{
"type": "object",
"properties": {
"trashEntryId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"trashEntryId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"restored": {
"type": "boolean",
"const": true
},
"trashEntryId": {
"type": "string"
}
},
"required": [
"restored",
"trashEntryId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴purge_trash_entry(trashEntryId, idempotencyKey)
Permanently delete one exact NotePom trash entry and its unreferenced stored objects.
Esquema de entrada
{
"type": "object",
"properties": {
"trashEntryId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"trashEntryId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"purged": {
"type": "boolean",
"const": true
},
"trashEntryId": {
"type": "string"
}
},
"required": [
"purged",
"trashEntryId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡upload_file(fileId, folderId, name, mimeType, contentBase64, ...)
Upload up to 10 MiB through NotePom without exposing a private storage URL.
Esquema de entrada
{
"type": "object",
"properties": {
"fileId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"folderId": {
"anyOf": [
{
"$ref": "#/properties/fileId"
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 320
},
"mimeType": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"contentBase64": {
"type": "string",
"minLength": 1,
"maxLength": 14000000
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"name",
"mimeType",
"contentBase64",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"sizeBytes": {
"type": "number"
},
"folderId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"mimeType",
"sizeBytes",
"folderId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢read_file(fileId)
Read up to 10 MiB from an authenticated NotePom file as base64 without a signed storage URL.
Esquema de entrada
{
"type": "object",
"properties": {
"fileId": {
"type": "string",
"minLength": 1,
"maxLength": 160
}
},
"required": [
"fileId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"sizeBytes": {
"type": "number"
},
"contentBase64": {
"type": "string"
}
},
"required": [
"id",
"name",
"mimeType",
"sizeBytes",
"contentBase64"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪move_file(fileId, folderId, idempotencyKey, expectedUpdatedAt)
Move an exact NotePom file into a folder or to the workspace root.
Esquema de entrada
{
"type": "object",
"properties": {
"fileId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"folderId": {
"anyOf": [
{
"$ref": "#/properties/fileId"
},
{
"type": "null"
}
]
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"fileId",
"folderId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"moved": {
"type": "boolean",
"const": true
},
"fileId": {
"type": "string"
},
"folderId": {
"type": [
"string",
"null"
]
}
},
"required": [
"moved",
"fileId",
"folderId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴trash_file(fileId, idempotencyKey, expectedUpdatedAt)
Move an exact NotePom file to trash.
Esquema de entrada
{
"type": "object",
"properties": {
"fileId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"fileId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"trashed": {
"type": "boolean",
"const": true
},
"trashEntryId": {
"type": "string"
}
},
"required": [
"trashed",
"trashEntryId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_public_pages
List active public pages owned by the authenticated workspace without password hashes or private URLs.
Esquema de entrada
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"pages": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
}
},
"required": [
"pages"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡publish_page(entityType, entityId, slug, accessMode, isListedOnProfile, ...)
Publish an exact note, folder or file as a NotePom public page.
Esquema de entrada
{
"type": "object",
"properties": {
"entityType": {
"type": "string",
"enum": [
"note",
"folder",
"file"
]
},
"entityId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"accessMode": {
"type": "string",
"enum": [
"public",
"password"
]
},
"isListedOnProfile": {
"type": "boolean"
},
"isIndexed": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"entityType",
"entityId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"page": {
"type": "object",
"additionalProperties": {}
},
"password": {
"type": [
"string",
"null"
]
}
},
"required": [
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡update_public_page(pageId, slug, accessMode, isListedOnProfile, isIndexed, ...)
Update access and visibility settings for an exact NotePom public page.
Esquema de entrada
{
"type": "object",
"properties": {
"pageId": {
"type": "string",
"format": "uuid"
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"accessMode": {
"type": "string",
"enum": [
"public",
"password"
]
},
"isListedOnProfile": {
"type": "boolean"
},
"isIndexed": {
"type": "boolean"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"pageId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"page": {
"type": "object",
"additionalProperties": {}
},
"password": {
"type": [
"string",
"null"
]
}
},
"required": [
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴unpublish_page(pageId, idempotencyKey)
Revoke an exact NotePom public page.
Esquema de entrada
{
"type": "object",
"properties": {
"pageId": {
"type": "string",
"format": "uuid"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"pageId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"revoked": {
"type": "boolean"
},
"pageId": {
"type": "string"
}
},
"required": [
"revoked"
],
"additionalProperties": true,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_collaboration_invitations
List pending collaboration invitations addressed to the authenticated account.
Esquema de entrada
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"invitations": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
}
},
"required": [
"invitations"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_shared_with_me
List collaboration targets shared with the authenticated account.
Esquema de entrada
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
}
}
},
"required": [
"items"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_collaboration_note(workspaceId, noteId)
Read an exact collaboration note and its Pretext documents after checking inherited access.
Esquema de entrada
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
}
},
"required": [
"workspaceId",
"noteId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"noteId": {
"type": "string"
},
"title": {
"type": "string"
},
"markdown": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": 0
},
"ownerId": {
"type": "string",
"format": "uuid"
},
"isOwner": {
"type": "boolean"
},
"publicPage": {
"anyOf": [
{
"type": "object",
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
}
},
"required": [
"workspaceId",
"noteId",
"title",
"markdown",
"revision",
"ownerId",
"isOwner",
"publicPage",
"updatedAt"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡update_collaboration_note(workspaceId, noteId, markdown, expectedRevision, idempotencyKey)
Replace the shared body of an exact collaboration note from Markdown with idempotency and an optional expected revision.
Esquema de entrada
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"markdown": {
"type": "string",
"maxLength": 5000000
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"workspaceId",
"noteId",
"markdown",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"entityType": {
"type": "string",
"const": "note"
},
"entityId": {
"type": "string"
},
"documentId": {
"type": "string",
"format": "uuid"
},
"revision": {
"type": "integer",
"minimum": 0
}
},
"required": [
"workspaceId",
"entityType",
"entityId",
"documentId",
"revision"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢invite_collaborator(workspaceId, entityType, entityId, identity, language, ...)
Invite a collaborator by NotePom username or email. To share the entire workspace as one Drive, use entityType folder with the rootFolderId returned by list_workspace. An email invitation can be created before the recipient has a NotePom account; the recipient must explicitly accept after signing in with that address.
Esquema de entrada
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"entityType": {
"type": "string",
"enum": [
"note",
"folder"
]
},
"entityId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"identity": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"description": "A NotePom username or an email address. Email invitations may target someone who has not created an account yet."
},
"language": {
"type": "string",
"minLength": 1,
"maxLength": 32,
"description": "BCP 47 language for an invitation recipient without a saved NotePom preference."
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"workspaceId",
"entityType",
"entityId",
"identity",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"email": {
"type": "string",
"format": "email"
},
"recipientUserId": {
"type": "string",
"format": "uuid"
},
"deliveryStatus": {
"type": "string",
"enum": [
"pending",
"sent",
"failed"
]
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"deliveryStatus",
"expiresAt"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪accept_collaboration_invitation(invitationId, idempotencyKey)
Accept an exact pending collaboration invitation addressed to this account.
Esquema de entrada
{
"type": "object",
"properties": {
"invitationId": {
"type": "string",
"format": "uuid"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"invitationId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"entityType": {
"type": "string",
"enum": [
"note",
"folder"
]
},
"entityId": {
"type": "string",
"minLength": 1,
"maxLength": 160
}
},
"required": [
"workspaceId",
"entityType",
"entityId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴revoke_collaboration_invitation(invitationId, idempotencyKey)
Revoke an exact invitation issued from the authenticated workspace.
Esquema de entrada
{
"type": "object",
"properties": {
"invitationId": {
"type": "string",
"format": "uuid"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"invitationId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"revoked": {
"type": "boolean",
"const": true
},
"invitationId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"revoked",
"invitationId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴revoke_collaborator(grantId, idempotencyKey)
Revoke one exact collaboration grant owned by the authenticated workspace.
Esquema de entrada
{
"type": "object",
"properties": {
"grantId": {
"type": "string",
"format": "uuid"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 160
}
},
"required": [
"grantId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"revoked": {
"type": "boolean",
"const": true
},
"grantId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"revoked",
"grantId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_seller_status
Return bounded Stripe Connect seller status and commission information.
Esquema de entrada
{
"type": "object",
"properties": {},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"connected": {
"type": "boolean"
},
"country": {
"type": [
"string",
"null"
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
{
"type": "null"
}
]
},
"chargesEnabled": {
"type": "boolean"
},
"payoutsEnabled": {
"type": "boolean"
},
"detailsSubmitted": {
"type": "boolean"
},
"canSell": {
"type": "boolean"
},
"mode": {
"type": "string",
"enum": [
"live",
"test"
]
},
"commissionBps": {
"type": "integer",
"minimum": 0
},
"standardCommissionBps": {
"type": "integer",
"minimum": 0
},
"nextSteps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"connected",
"country",
"currency",
"chargesEnabled",
"payoutsEnabled",
"detailsSubmitted",
"canSell",
"mode",
"commissionBps",
"standardCommissionBps",
"nextSteps"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_sellable_content(kind, limit, cursor)
List bounded metadata for the authenticated user’s notes and media occurrences.
Esquema de entrada
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"all",
"note",
"media"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"cursor": {
"type": "string",
"pattern": "^\\d{1,12}$"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"title": {
"type": "string"
},
"noteId": {
"type": "string"
},
"fileId": {
"type": "string"
},
"mediaId": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"sizeBytes": {
"type": "integer",
"minimum": 0
},
"isPublic": {
"type": "boolean"
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
},
"listing": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"status": {
"type": "string"
},
"noteId": {
"type": [
"string",
"null"
]
},
"fileId": {
"type": [
"string",
"null"
]
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"title",
"description",
"kind",
"status",
"noteId",
"fileId",
"amountMinor",
"currency",
"currencyExponent",
"publishedAt",
"publicUrl"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"kind",
"title",
"noteId",
"isPublic",
"updatedAt",
"listing"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"items",
"nextCursor"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢validate_listing_readiness(kind, noteId, fileId, mediaId, amountMinor, ...)
Purely validate a note or media listing and issue a short-lived bound preparation token when ready.
Esquema de entrada
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"fileId": {
"$ref": "#/properties/noteId"
},
"mediaId": {
"$ref": "#/properties/noteId"
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
}
},
"required": [
"kind",
"noteId",
"amountMinor",
"currency"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"ready": {
"type": "boolean"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"field": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"additionalProperties": false
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"additionalProperties": false
}
},
"effects": {
"type": "array",
"items": {
"type": "string"
}
},
"preparationToken": {
"type": [
"string",
"null"
]
},
"expiresAt": {
"type": [
"string",
"null"
]
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"mode": {
"type": "string",
"enum": [
"live",
"test"
]
}
},
"required": [
"ready",
"blockers",
"warnings",
"effects",
"preparationToken",
"expiresAt",
"amountMinor",
"currency",
"currencyExponent",
"mode"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_listing(productId, slug)
Return one marketplace listing owned by the authenticated seller. Provide exactly one of productId or slug.
Esquema de entrada
{
"type": "object",
"properties": {
"productId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"slug": {
"$ref": "#/properties/productId"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"status": {
"type": "string"
},
"noteId": {
"type": [
"string",
"null"
]
},
"fileId": {
"type": [
"string",
"null"
]
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"title",
"description",
"kind",
"status",
"noteId",
"fileId",
"amountMinor",
"currency",
"currencyExponent",
"publishedAt",
"publicUrl"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_seller_sales(limit, cursor)
Return paid seller sales only, bounded and grouped by currency.
Esquema de entrada
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"cursor": {
"type": "string",
"pattern": "^\\d{1,12}$"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"totals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"type": "integer",
"minimum": 0
},
"grossAmountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"feeAmountMinor": {
"$ref": "#/properties/totals/items/properties/grossAmountMinor"
},
"netAmountMinor": {
"$ref": "#/properties/totals/items/properties/grossAmountMinor"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"required": [
"currency",
"currencyExponent",
"grossAmountMinor",
"feeAmountMinor",
"netAmountMinor",
"count"
],
"additionalProperties": false
}
},
"sales": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"productTitle": {
"type": "string"
},
"amountMinor": {
"$ref": "#/properties/totals/items/properties/grossAmountMinor"
},
"currency": {
"$ref": "#/properties/totals/items/properties/currency"
},
"currencyExponent": {
"type": "integer",
"minimum": 0
},
"feeAmountMinor": {
"$ref": "#/properties/totals/items/properties/grossAmountMinor"
},
"status": {
"type": "string",
"const": "paid"
},
"at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"productTitle",
"amountMinor",
"currency",
"currencyExponent",
"feeAmountMinor",
"status",
"at"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"totals",
"sales",
"nextCursor"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡create_stripe_onboarding_session(country, idempotencyKey)
Create a short-lived Stripe Connect onboarding link with NotePom return paths.
Esquema de entrada
{
"type": "object",
"properties": {
"country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$"
},
"idempotencyKey": {
"type": "string",
"minLength": 1,
"maxLength": 160
}
},
"required": [
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"mode": {
"type": "string",
"enum": [
"live",
"test"
]
}
},
"required": [
"url",
"mode"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡publish_note_listing(noteId, amountMinor, currency, description, languageMode, ...)
Publish or update a complete-note marketplace listing after readiness and client confirmation.
Esquema de entrada
{
"type": "object",
"properties": {
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"description": {
"type": "string",
"maxLength": 4000
},
"languageMode": {
"type": "string",
"enum": [
"auto",
"manual"
]
},
"contentLanguage": {
"type": "string",
"maxLength": 64
},
"readinessToken": {
"type": "string",
"minLength": 20,
"maxLength": 4000
},
"idempotencyKey": {
"$ref": "#/properties/noteId"
}
},
"required": [
"noteId",
"amountMinor",
"currency",
"readinessToken",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"listing": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"status": {
"type": "string"
},
"noteId": {
"type": [
"string",
"null"
]
},
"fileId": {
"type": [
"string",
"null"
]
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"title",
"description",
"kind",
"status",
"noteId",
"fileId",
"amountMinor",
"currency",
"currencyExponent",
"publishedAt",
"publicUrl"
],
"additionalProperties": false
},
"listingUrl": {
"type": "string",
"format": "uri"
},
"effects": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"listing",
"listingUrl",
"effects"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟡publish_media_listing(noteId, amountMinor, currency, description, languageMode, ...)
Publish or update a media marketplace listing after readiness and client confirmation.
Esquema de entrada
{
"type": "object",
"properties": {
"noteId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"description": {
"type": "string",
"maxLength": 4000
},
"languageMode": {
"type": "string",
"enum": [
"auto",
"manual"
]
},
"contentLanguage": {
"type": "string",
"maxLength": 64
},
"readinessToken": {
"type": "string",
"minLength": 20,
"maxLength": 4000
},
"idempotencyKey": {
"$ref": "#/properties/noteId"
},
"mediaId": {
"$ref": "#/properties/noteId"
},
"fileId": {
"$ref": "#/properties/noteId"
}
},
"required": [
"noteId",
"amountMinor",
"currency",
"readinessToken",
"idempotencyKey",
"mediaId",
"fileId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"listing": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"status": {
"type": "string"
},
"noteId": {
"type": [
"string",
"null"
]
},
"fileId": {
"type": [
"string",
"null"
]
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"title",
"description",
"kind",
"status",
"noteId",
"fileId",
"amountMinor",
"currency",
"currencyExponent",
"publishedAt",
"publicUrl"
],
"additionalProperties": false
},
"listingUrl": {
"type": "string",
"format": "uri"
},
"effects": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"listing",
"listingUrl",
"effects"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🔴disable_listing(productId, idempotencyKey)
Reversibly stop a seller-owned listing by productId after client confirmation.
Esquema de entrada
{
"type": "object",
"properties": {
"productId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"idempotencyKey": {
"$ref": "#/properties/productId"
}
},
"required": [
"productId",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"listing": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"note",
"media"
]
},
"status": {
"type": "string"
},
"noteId": {
"type": [
"string",
"null"
]
},
"fileId": {
"type": [
"string",
"null"
]
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
}
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publicUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"title",
"description",
"kind",
"status",
"noteId",
"fileId",
"amountMinor",
"currency",
"currencyExponent",
"publishedAt",
"publicUrl"
],
"additionalProperties": false
},
"effects": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"listing",
"effects"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢prepare_checkout(slug)
Prepare a public NotePom checkout handoff without creating a Stripe session or purchase.
Esquema de entrada
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 160
}
},
"required": [
"slug"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Esquema de salida
{
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"seller": {
"type": "string"
},
"amountMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"currencyExponent": {
"type": "integer",
"minimum": 0
},
"checkoutUrl": {
"type": "string",
"format": "uri"
},
"requiresWebConsent": {
"type": "boolean",
"const": true
},
"stripeSessionCreated": {
"type": "boolean",
"const": false
},
"purchaseCreated": {
"type": "boolean",
"const": false
}
},
"required": [
"slug",
"title",
"seller",
"amountMinor",
"currency",
"currencyExponent",
"checkoutUrl",
"requiresWebConsent",
"stripeSessionCreated",
"purchaseCreated"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Comunidad
Evidencia
Observaciones recientes
verificadoversión no registrada39 herramientas
verificadoversión no registrada39 herramientas