PostApiV3SaveRequest2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/readwise/json-schema/readwise-post-api-v3-save-request2-schema.json",
  "title": "PostApiV3SaveRequest2",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/readwise-openapi-generated.yml#/components/schemas/PostApiV3SaveRequest2",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The document's unique URL. If you don't have one, you can provide a made up value such as https://yourapp.com#document1. Required unless parent_id is set."
    },
    "html": {
      "type": "string",
      "description": "The document's content, in valid html. If you don't provide this, we will try to scrape the URL you provided."
    },
    "should_clean_html": {
      "type": "boolean",
      "description": "Only valid when html is provided. Pass true to have us automatically clean the html and parse the metadata (title/author) of the document for you."
    },
    "title": {
      "type": "string",
      "description": "The document's title, it will overwrite the original title of the document."
    },
    "author": {
      "type": "string",
      "description": "The document's author, it will overwrite the original author."
    },
    "summary": {
      "type": "string",
      "description": "Summary of the document."
    },
    "language": {
      "type": "string",
      "description": "The document's language code, such as en, de, or en-US."
    },
    "published_date": {
      "type": "string",
      "description": "A datetime representing when the document was published in the ISO 8601 format."
    },
    "image_url": {
      "type": "string",
      "description": "An image URL to use as cover image."
    },
    "location": {
      "type": "string",
      "description": "One of: new, later, archive or feed. Default is new."
    },
    "category": {
      "type": "string",
      "description": "One of: article, email, rss, highlight, pdf, epub, tweet or video."
    },
    "saved_using": {
      "type": "string",
      "description": "This value represents the source of the document."
    },
    "tags": {
      "type": "array",
      "description": "A list of strings containing tags."
    },
    "notes": {
      "type": "string",
      "description": "A top-level note of the document, or the note attached to the highlight when parent_id is set."
    },
    "parent_id": {
      "type": "string",
      "description": "Highlights only. The id of the document to highlight."
    },
    "content": {
      "type": "string",
      "description": "Highlights only. The passage to highlight. Required when parent_id is set."
    }
  }
}