Paragraph with emphasis.
" }, { "type": "image", "url": "https://example.com/diagram.png", "alt": "Architecture diagram" } ] } }, "update": { "summary": "Update a previously-published page (id + editKey required).", "value": { "id": "abc123", "editKey": "REPLACE_WITH_EDIT_KEY_FROM_PREVIOUS_PUBLISH", "content": "# Updated\n\nReplaced body." } } } }, "text/markdown": { "schema": { "type": "string", "description": "Raw markdown body. Equivalent to POSTing { \"content\": } as JSON. Useful for one-shot curl / agent calls that don't want to JSON-encode their content.", "example": "# Hello\n\nA page in one call." } }, "text/plain": { "schema": { "type": "string", "description": "Raw text body, parsed as markdown. Same handling as text/markdown.", "example": "# Hello\n\nA page in one call." } } } }, "responses": { "200": { "description": "Page successfully created or updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishResponse" } } } }, "400": { "description": "Input could not be parsed or no usable content was provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "editKey missing or wrong on an update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown id on an update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded (30 publishes / 5 minutes / IP). Response includes Retry-After and X-RateLimit-* headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error. Retry with backoff.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/pages/{id}": { "get": { "operationId": "getPage", "summary": "Read the content of a published page.", "description": "Returns the stored content of a page as JSON. Use this to verify a just-published page, to summarize what is currently live at a URL, or to fetch the blocks before editing them. Read-only; no editKey required.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The page id from the public URL.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Page found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageReadResponse" } } } }, "400": { "description": "Missing id parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No page exists at this id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "setPagePublished", "summary": "Toggle a page between published and unpublished.", "description": "Hide a page from the public render route without losing its content (or re-expose a previously-hidden one). The page record stays intact and editable; unpublished pages 404 at https://quicky.page/{id} but remain readable via this API for the editKey holder.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The page id from the public URL.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPublishedRequest" } } } }, "responses": { "200": { "description": "Publish state updated.", "content": { "application/json": { "schema": { "type": "object", "required": ["id", "published"], "properties": { "id": { "type": "string" }, "published": { "type": "boolean" } } } } } }, "400": { "description": "Invalid body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "editKey missing or wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deletePage", "summary": "Permanently delete a page.", "description": "Permanently deletes a page when the caller provides its editKey. This is irreversible: later API reads and public visits return 404. To hide without deleting, use setPagePublished with published false.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The page id from the public URL.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRequest" } } } }, "responses": { "200": { "description": "Page deleted.", "content": { "application/json": { "schema": { "type": "object", "required": ["id", "deleted"], "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "const": true } } } } } }, "400": { "description": "Invalid body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "editKey missing or wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/pages/{id}/blocks": { "post": { "operationId": "appendPageBlocks", "summary": "Append content blocks to an existing page.", "description": "Append markdown or qp.v1 blocks to a page using its editKey. Unlike publish update, this preserves the page's existing visibility state.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Page id." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppendBlocksRequest" } } } }, "responses": { "200": { "description": "Blocks appended.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppendBlocksResponse" } } } }, "400": { "description": "Invalid body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "editKey missing or wrong.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "PublishRequest": { "type": "object", "description": "Publish (or update) request body. Provide exactly one of `content` or `blocks` for the body. To update an existing page, additionally include both `id` and `editKey` from a previous response.", "properties": { "title": { "type": "string", "maxLength": 500, "description": "Optional title. When set, becomes the leading