> ## Documentation Index
> Fetch the complete documentation index at: https://docs.webless.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Quick Read

> Returns concise Quick Read bullets for the indexed content at the supplied page URL. The browser sends URL context, not full page content.

<Note>
  Send page URL context only. Do not send the full page body from the browser.
  The API looks up indexed content for the URL and returns `not_found` when the
  page is not available in the published index.
</Note>

Use `max_bullets` to control the number of takeaways. The endpoint supports
`published` by default and `unpublished` when you are testing runtime package
changes before publishing.


## OpenAPI

````yaml api-reference/openapi-latest.json POST /api/v1/quick-read
openapi: 3.1.0
info:
  title: Webless API
  description: >-
    Reference for the latest Webless API surface. New integrations should use
    the /api/v1 endpoints.
  version: v1
servers:
  - url: https://api.webless.ai
    description: Production Search API
security: []
paths:
  /api/v1/quick-read:
    post:
      tags:
        - Search API
      summary: Create Quick Read
      description: >-
        Returns concise Quick Read bullets for the indexed content at the
        supplied page URL. The browser sends URL context, not full page content.
      operationId: createQuickReadV1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1QuickReadRequest'
            examples:
              default:
                value:
                  company: YOUR_COMPANY
                  canonical_url: https://example.com/articles/product-launch
                  page_url: https://example.com/articles/product-launch#webless
                  title: Product launch
                  version: published
                  max_bullets: 3
                  requestId: 1f7c5f74-7b9e-4a0a-9b7d-4e3e2a5e3b60
                  sessionId: a1c2d3e4-1111-2222-3333-444455556666
      responses:
        '200':
          description: Quick Read result for the supplied page URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1QuickReadResponse'
              examples:
                ready:
                  value:
                    status: ready
                    bullets:
                      - First concise takeaway.
                      - Second concise takeaway.
                      - Third concise takeaway.
                    source_url: https://example.com/articles/product-launch
                    title: Product launch
                    cache_status: miss
                    version: published
                    resolved_version: published
                    resolved_corpus_version: 12
                    generated_at: '2026-06-12T19:30:00+00:00'
                not_found:
                  value:
                    status: not_found
                    bullets: []
                    source_url: https://example.com/articles/product-launch
                    title: Product launch
                    cache_status: miss
                    version: published
                    resolved_version: published
                    resolved_corpus_version: 12
                    generated_at: '2026-06-12T19:30:00+00:00'
        '422':
          description: Invalid request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
components:
  schemas:
    V1QuickReadRequest:
      type: object
      required:
        - company
        - canonical_url
      properties:
        company:
          type: string
          description: Public company or index identifier.
        canonical_url:
          type: string
          description: Canonical URL of the page to summarize.
        page_url:
          type: string
          description: >-
            Current browser URL. Optional; fragments and tracking params are
            normalized server-side.
        title:
          type: string
          description: Optional page title for display and prompt context.
        locale:
          type: string
          description: Optional locale or language hint.
        requestId:
          type: string
          description: Caller-generated request identifier.
        sessionId:
          type: string
          description: Caller-generated session identifier.
        is_private_session:
          type: boolean
          default: false
          description: When true, skips cache and private-session-aware logging.
        model:
          type: string
          default: gpt
          description: Model alias configured for the runtime package.
        version:
          $ref: '#/components/schemas/V1RuntimeVersion'
        max_bullets:
          type: integer
          minimum: 1
          maximum: 5
          default: 3
          description: Maximum number of Quick Read bullets to return.
    V1QuickReadResponse:
      type: object
      required:
        - status
        - bullets
        - cache_status
      properties:
        status:
          $ref: '#/components/schemas/V1QuickReadStatus'
        bullets:
          type: array
          items:
            type: string
          description: Concise page takeaways. Empty when status is not_found.
        source_url:
          type: string
          nullable: true
          description: Normalized source URL used for lookup.
        title:
          type: string
          nullable: true
          description: Page title returned by the request or indexed content.
        cache_status:
          $ref: '#/components/schemas/V1QuickReadCacheStatus'
        version:
          $ref: '#/components/schemas/V1RuntimeVersion'
        resolved_version:
          type: string
          nullable: true
          description: Resolved runtime pointer after fallback handling.
        resolved_corpus_version:
          type: integer
          nullable: true
          description: Resolved indexed corpus version used internally for the response.
        generated_at:
          type: string
          format: date-time
          nullable: true
          description: Server timestamp for the generated response.
    ValidationErrorResponse:
      type: object
      properties:
        detail:
          type: array
          items:
            type: object
            additionalProperties: true
    V1RuntimeVersion:
      type: string
      enum:
        - published
        - unpublished
      default: published
      description: >-
        Runtime package pointer. Omit this field or use `published` for
        production traffic. Use `unpublished` only when testing an unpublished
        runtime package.
    V1QuickReadStatus:
      type: string
      enum:
        - ready
        - not_found
        - error
      description: Quick Read generation status.
    V1QuickReadCacheStatus:
      type: string
      enum:
        - hit
        - miss
        - bypass
      description: Whether the response came from cache.

````