haoku.app

{
  "type": "object",
  "properties": {
    "block_id": {
      "type": "string",
      "description": "Defaults to the selected block."
    },
    "passages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string",
            "description": "A source by id (from list_sources) or by file name."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "Page number as printed, starting at 1. Text sources are a single page."
          },
          "quote": {
            "type": "string",
            "description": "A passage of the source, quoted from read_source or search_sources. Spacing, line breaks and hyphenation do not matter."
          },
          "occurrence": {
            "type": "integer",
            "minimum": 1,
            "description": "Which occurrence when the quote repeats on the page. Defaults to 1."
          }
        },
        "required": [
          "source"
        ],
        "description": "Where a piece of content comes from. Give page and quote for PDFs and text; an image is cited by source alone."
      }
    },
    "use_collected": {
      "type": "boolean",
      "description": "Defaults to true: links the passages the user gathered in the context and has not used yet (get_selection → gathered, the ones with free: true), and empties the basket. Pass false to link only the passages listed here."
    }
  }
}