Inkbind

Lays out a story, memoir, letters or recipe collection from this conversation as a printed 8.5-inch square book and shows a page-by-page preview. Use it when the user wants something written in the chat turned into a physical book, or to change a book made earlier (pass book_id; only the fields you pass change). Pass the text exactly as written, split into sections (one per page of a picture book, or one per chapter/recipe). Never summarise or shorten it. This client cannot pass pictures from the conversation: leave `images` empty; the result has an editor link where the user uploads pictures. This only creates a draft preview; nothing is printed or charged.

{
  "type": "object",
  "properties": {
    "book_id": {
      "description": "Id of a book made earlier, to update it",
      "type": "string"
    },
    "title": {
      "description": "Book title",
      "type": "string"
    },
    "subtitle": {
      "type": "string"
    },
    "author": {
      "description": "Author name as it should appear on the cover, e.g. \"Grandma Rosa\"",
      "type": "string"
    },
    "dedication": {
      "description": "Dedication page text, e.g. \"For Lucía, love Mum\"",
      "type": "string"
    },
    "language": {
      "description": "Language the book is written in (sets the printed words like \"The End\"). Defaults to the conversation language.",
      "type": "string",
      "enum": [
        "en",
        "es",
        "de",
        "fr",
        "it",
        "nl",
        "pt",
        "sv",
        "pl"
      ]
    },
    "style": {
      "description": "picture = one picture and short text per spread (children's stories); text = flowing chapters (memoirs, recipes, letters)",
      "type": "string",
      "enum": [
        "picture",
        "text"
      ]
    },
    "sections": {
      "description": "The book content in order",
      "maxItems": 60,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "heading": {
            "description": "Chapter or recipe title, if the text has one",
            "type": "string"
          },
          "text": {
            "type": "string",
            "description": "The text for this part, exactly as written in the conversation"
          },
          "image": {
            "description": "Index into `images` of the picture that goes with this part",
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "image_url": {
            "description": "Public https URL of a picture for this part, when the picture is not a conversation file",
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "text"
        ]
      }
    },
    "full_text": {
      "description": "Alternative to sections: the whole text; it is split at blank lines",
      "type": "string"
    },
    "images": {
      "description": "Pictures from the conversation, in the order referenced by sections",
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "download_url": {
            "type": "string",
            "description": "Temporary download URL of the file"
          },
          "file_id": {
            "type": "string",
            "description": "File id"
          },
          "mime_type": {
            "type": "string"
          },
          "file_name": {
            "type": "string"
          }
        },
        "required": [
          "download_url",
          "file_id"
        ]
      }
    },
    "cover_image": {
      "description": "Index into `images` for the front cover; defaults to the first picture",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "country": {
      "description": "ISO country code the book will ship to, if known, to show the right price",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Lists the printed book formats (hardcover, softcover), prices including shipping, and delivery times for a destination country. Use when the user asks what a printed book costs or how long delivery takes.

{
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "description": "ISO 3166 country code the book ships to, e.g. ES, US, GB"
    }
  },
  "required": [
    "country"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Creates a checkout link for a book laid out with layout_book. The user opens it, enters the shipping address and pays on inkbind.onmax.me; only then is the book printed. Nothing is charged by this call.

{
  "type": "object",
  "properties": {
    "book_id": {
      "type": "string"
    },
    "format": {
      "type": "string",
      "enum": [
        "hardcover",
        "softcover"
      ]
    },
    "country": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "description": "ISO country code of the delivery address"
    },
    "speed": {
      "type": "string",
      "enum": [
        "standard",
        "faster",
        "express"
      ]
    },
    "quantity": {
      "description": "Copies of the same book to the same address",
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    }
  },
  "required": [
    "book_id",
    "format",
    "country"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Returns the status and tracking link of a printed book order by its order code (looks like IB-XXXXXXX).

{
  "type": "object",
  "properties": {
    "order_code": {
      "type": "string",
      "description": "Order code, e.g. IB-7K2Q9MX"
    }
  },
  "required": [
    "order_code"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}