/zenn/books/chapters

POST /api/zenn/books/chapters

Price: 1 credit

Get Zenn Book Chapter

How to use it

Read one chapter of a Zenn book. Returns the rendered chapter body and its plain-text form, the chapter table of contents, its position in the book, its length, the links to the source markdown file when the book is synced from a GitHub repository, and a reference to the book itself. Chapters that are not free to read in a paid book come back without a body, with is_free false.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• book string required — Book slug or book URL (examples: "nextjs-basic-principle", "https://zenn.dev/akfm/books/nextjs-basic-principle")
• chapter string required — Chapter slug, numeric chapter id or chapter URL (examples: "intro", "74554", "https://zenn.dev/akfm/books/nextjs-basic-principle/viewer/intro")

Response

• @type string (default: "ZennChapter")
• id integer required
• alias string required
• chapter_title string nullable
• url string nullable
• position integer nullable
• is_free boolean (default: false)
• letter_count integer nullable
• filename string nullable
• body_updated_at integer nullable
• source_repo_updated_at integer nullable
• github_url string nullable
• github_dev_url string nullable
• text string nullable
• text_html string nullable
• toc array (default: [])
  • @type string (default: "ZennTocEntry")
  • text string required
  • id string nullable
  • level integer nullable
  • children array (default: [])
• book object nullable
  • @type string (default: "ZennBookRef")
  • id integer required
  • alias string required
  • book_title string nullable
  • url string nullable
  • image string nullable
  • price integer nullable
  • is_bestseller boolean (default: false)
  • published_at integer nullable
  • body_updated_at integer nullable
  • source_repo_updated_at integer nullable
  • like_count integer nullable
  • user object nullable
    • @type string (default: "ZennUserRef")
    • id integer required
    • alias string required
    • name string nullable
    • image string nullable
    • url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Book or chapter not found. Verify the book slug and the chapter slug or id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.