Greenlit Books Cite API

openapi: 3.2.0
info:
  title: Greenlitbooks Com Cite API
  version: 1.2.0
  contact:
    name: Greenlit Books
    url: https://greenlitbooks.com
  description: 'Operations tagged Cite across 2 of this provider''s published API definitions: greenlitbooks-com-openapi-gpt.json, greenlitbooks-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://greenlitbooks.com/api/v1
security: []
tags:
- name: Cite
paths:
  /cite:
    get:
      operationId: citeUrl
      summary: The finished citation for any url on this site
      description: Get the ready-made citation for any greenlitbooks.com URL you are about to quote.
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: An https url on greenlitbooks.com, or a bare path. The fragment, the .md suffix, a trailing slash and a query string are all handled. A url on another host is refused rather than guessed at.
        example: https://greenlitbooks.com/book/blast-radius#claim-1
      responses:
        '200':
          description: The citation for the thing at that url
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/Meta'
                  query:
                    type: object
                    properties:
                      url:
                        type: string
                  note:
                    type: string
                  kind:
                    type: string
                    enum:
                    - book
                    - claim
                    - chapter
                    - chapter-section
                    - field-note
                    - field-note-section
                    - concept
                    - term
                    - page
                    description: What the url turned out to point at.
                  url:
                    type: string
                    format: uri
                    description: The canonical url of the thing cited, fragment included when it resolved.
                  pageUrl:
                    type: string
                    format: uri
                  markdownUrl:
                    type:
                    - string
                    - 'null'
                    format: uri
                  title:
                    type: string
                  author:
                    type:
                    - string
                    - 'null'
                  citation:
                    $ref: '#/components/schemas/Citation'
                  basis:
                    type: object
                    description: 'Present for a claim: what kind of statement it is and the rule for quoting that kind honestly.'
                    properties:
                      label:
                        type: string
                      rule:
                        type: string
                  fragmentNote:
                    type: string
                    description: Present when the fragment is not published on that page. The citation then covers the page, and anchors lists what could have been cited instead.
                  anchors:
                    type: array
                    description: The linkable headings this document publishes.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        text:
                          type: string
                        url:
                          type: string
                          format: uri
        '400':
          description: Missing url, a url that is not one, or a url on another host
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: A url on this site with no page behind it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Cite
    servers:
    - url: https://greenlitbooks.com/api/v1
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              examples:
              - not_found
              - missing_query
            message:
              type: string
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      description: Envelope on every response.
      properties:
        version:
          type: string
          const: v1
        generatedAt:
          type: string
          format: date-time
          description: When this snapshot was produced. Static endpoints stamp it at deploy; search stamps it per request.
        source:
          type: string
          format: uri
        docs:
          type: string
          format: uri
        openapi:
          type: string
          format: uri
    Citation:
      type: object
      description: The citation for this claim, already written, in the forms people paste. Both carry the fragment URL, so a quote taken from this export attributes itself.
      properties:
        url:
          type: string
          format: uri
          description: The fragment the citation points at.
        text:
          type: string
          description: Ready to paste into prose. The same string the book page renders. It ends with the date the record was last reviewed rather than an access date, because a build-time access date would describe when the page was generated, not when it was read.
        bibtex:
          type: string
          description: Ready to paste into a .bib file.
        key:
          type: string
          description: The BibTeX key on its own, for citing in LaTeX.
externalDocs:
  description: Human documentation, the MCP server, and the markdown surfaces for agents
  url: https://greenlitbooks.com/developers
x-refined-from:
- greenlitbooks-com-openapi-gpt.json
- greenlitbooks-com-openapi.json