pull/note retrieve individual note

/pull/note/[slug]

Retrieve a note with title, content_html and all other pertinent information to build a page.

GET Parameters

key: string (optional) api_key for your project, also passable as a Bearer token in the header

Retrieve or Create (roc) Mode (NB: push must be enabled in settings)

roc: integer Set to '1' to signal you wish the note to be created if not found

title: string (optional) The title of the newly created note

prompt: string (optional) Additional prompt for the LLM when generating AI content

img: string (optional) Pass 1 or string prompt to generate AI image to accompany article

Return Parameters

title: string Title of the page

description: string Description for the page

picture: string Image url if one supplied / generated

head_html: string Entire HEAD section, including SEO tags and JSON_LD

content_html: string Entire BODY (bar the title) already HTML rendered

content_md: string The raw, original markdown if you wish to perform your own processing / conversion

category: note Parent note (if applicable)

links: [note] Array of sub-documents (if applicable) to use as basis for a menu

Example

https://pullnote.com/pull/note?key=...

{
  "_id":"65b25e6152be6b2f62100382",
  "title":"Simple, Headless Markdown Blogs",
  "description":"Homepage for the Pullnote headless CMS blog engine.",
  "picture":"https://pullnote.com/i/hero-img.png",
  "head_html": "<title>...</title> etc.",
  "content_html": "<h2>First subheading</h2><p>...etc...</p>",
  "content_md":"## First subheading\n etc.",
  "pathname":"/simple-headless-markdown-blogs",
  "href":"https://pullnote.com/simple-headless-markdown-blogs",
  "category": {...parentdocument},
  "links": [{...subdocuments}],
  "is_root": 1,
  "type": "article",
  "card":"summary_large_image",
  "img":{
    "src":"https://pullnote.com/i/hero-img.png",
    "alt":"Simple, Headless Markdown Blogs"
  },
  "dateCreated":"2024-01-27",
  "dateModified":"2024-02-13",
  "json_ld": {}
}