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

# Read a published Ravi Page's content by URL



## OpenAPI

````yaml /openapi.json post /api/v1/pages/read
openapi: 3.1.0
info:
  description: >-
    OpenAPI 3.1 spec auto-generated from the Ravi CLI registry. Each operation
    maps 1:1 to a `ravi <group> <command>` invocation.
  title: Ravi API
  version: 974aebaaf457a15f
servers:
  - description: Local Ravi gateway (default)
    url: http://localhost:3000
security: []
tags:
  - description: Ask a Ravi Page's managers for access and follow the request
    name: access
  - description: Inspect session adapters and their debug snapshots
    name: adapters
  - description: >-
      The operator's calendar in the Ravi Console: meetings, recording and
      briefings
    name: agenda
  - description: Agent management
    name: agents
  - description: Discover and validate Ravi app manifests
    name: apps
  - description: Generic artifact ledger and lineage tools
    name: artifacts
  - description: Audio generation tools (TTS)
    name: audio
  - description: Typed project databases (Bases) in Ravi Console
    name: bases
  - description: Manage Ravi MCP bridges through Console
    name: bridges
  - description: File, comment on, and track global Ravi bug reports on Console
    name: bug
  - description: Manage local-first Ravi calendars
    name: calendars
  - description: Manage native Ravi channel runner
    name: channels
  - description: Inspect canonical chats, messages, and reading queues
    name: chats
  - name: cloud
  - description: Manage Ravi prompt commands
    name: commands
  - description: >-
      Connect and manage your own accounts (Gmail, Calendar, ...) through Ravi
      Console
    name: connectors
  - description: Contact management
    name: contacts
  - description: Runtime context registry and introspection
    name: context
  - description: Inspect token and cost tracking
    name: costs
  - name: credentials
  - description: CRM relationship surface
    name: crm
  - description: Scheduled job management
    name: cron
  - description: Manage ravi via PM2
    name: daemon
  - description: Inspect ravi.db state (locks, WAL, holders)
    name: db
  - name: devin
  - description: Run reproducible evaluation tasks against Ravi
    name: eval
  - description: Stream live NATS events
    name: events
  - description: Send structured feedback to Ravi Console
    name: feedback
  - description: >-
      Operate Gmail through a connected Google account (yours, the person
      asking's, or a shared one)
    name: gmail
  - description: Heartbeat scheduling management
    name: heartbeat
  - description: Generic runtime hooks
    name: hooks
  - description: Link chat people to their Ravi Console account
    name: identity
  - description: Image generation tools
    name: image
  - description: Local Ravi inbox and Console delivery compatibility commands
    name: inbox
  - description: Operational insights with explicit lineage
    name: insights
  - description: Instance management (channels, policies, routes)
    name: instances
  - description: Invite people into the Console organization by email
    name: invites
  - description: Execução de chamada longa em background, com desfecho entregue na sessão
    name: jobs
  - description: Search what the org said and published, with sources
    name: knowledge
  - description: Use local-first Ravi mail
    name: mail
  - description: Media sending
    name: media
  - description: Meeting artifact and provider operations
    name: meetings
  - description: Daily metrics rollup and reporting
    name: metrics
  - description: Inspect Observation Plane bindings
    name: observers
  - description: Manage project-owned Ravi Pages and publish content through Console
    name: pages
  - description: Inspect provider-runtime authorization
    name: permissions
  - description: List and create the organization's projects in Ravi Console
    name: projects
  - name: prox
  - description: Emoji reactions
    name: react
  - description: Inspect route config and live routing without drilling into instances
    name: routes
  - description: Manage Ravi runtime prompt rules
    name: rules
  - name: runtime
  - description: Run one Ravi task in a disposable E2B cloud sandbox and collect its patch
    name: sandbox
  - name: sdk
  - description: Read the current Ravi agent/session/chat context
    name: self
  - description: Bot service management
    name: service
  - description: Manage agent sessions
    name: sessions
  - description: Global settings management
    name: settings
  - description: Manage runtime skill gate rules
    name: skill-gates
  - description: Skill discovery, install and inspection tools
    name: skills
  - description: Native Slack workspace operations
    name: slack
  - description: Versioned Ravi specs memory
    name: specs
  - description: Sticker library management and sending
    name: stickers
  - description: Local-first sync outbox, inbox, and Console bridge
    name: sync
  - description: Deterministic tag classification rules
    name: tag-rules
  - description: Unified tags for Ravi assets
    name: tags
  - description: Task runtime for dispatching work to Ravi agents
    name: tasks
  - description: >-
      Org and project themes in the Console Library: check, publish, propose and
      set the active theme
    name: themes
  - description: Manage Ravi threads
    name: threads
  - description: CLI tools inspection and export
    name: tools
  - description: Audio transcription
    name: transcribe
  - description: Event triggers
    name: triggers
  - description: Video analysis tools
    name: video
  - description: Create watches and wire their events to triggers
    name: watch
  - name: whatsapp
  - description: >-
      Widget templates in the Console Library: catalog, check, preview, publish
      and propose
    name: widgets
  - description: Resolve and mutate generic Work Objects through Ravi domain adapters
    name: work-objects
  - name: workflows
  - description: >-
      Operate YouTube Data API v3 and YouTube Analytics API v2 through Ravi
      credentials
    name: yt
paths:
  /api/v1/pages/read:
    post:
      tags:
        - pages
      summary: Read a published Ravi Page's content by URL
      operationId: pages.read
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                console:
                  description: Console base URL
                  type: string
                cursor:
                  description: Character offset to continue a long page (from nextCursor)
                  type: string
                customDomain:
                  description: Allow a host that is not *.ravi.page (a custom Pages domain)
                  type: boolean
                format:
                  description: >-
                    markdown (default, text only), html (entry source), zip or
                    files (every published file, with --out)
                  type: string
                maxChars:
                  description: Characters to return (1000-256000, default 256000)
                  type: string
                out:
                  description: >-
                    Where --format zip writes the .zip, or --format files the
                    directory
                  type: string
                url:
                  description: Ravi Page URL, such as https://acme.ravi.page/weekly
                  type: string
              required:
                - url
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  consoleUrl:
                    type: string
                  content:
                    additionalProperties: false
                    properties:
                      cursor:
                        type: number
                      format:
                        enum:
                          - markdown
                          - html
                          - files
                          - zip
                        type: string
                      nextCursor:
                        anyOf:
                          - type: number
                          - type: 'null'
                      note:
                        type: string
                      representation:
                        enum:
                          - extracted_markdown
                          - entry_source
                          - file_list
                        type: string
                      text:
                        type: string
                      totalChars:
                        type: number
                      truncated:
                        type: boolean
                    required:
                      - format
                      - representation
                      - note
                      - text
                      - cursor
                      - nextCursor
                      - totalChars
                      - truncated
                    type: object
                  contentTrust:
                    const: untrusted
                    type: string
                  download:
                    additionalProperties: false
                    properties:
                      files:
                        items:
                          additionalProperties: false
                          properties:
                            contentType:
                              type: string
                            entrypoint:
                              type: boolean
                            path:
                              type: string
                            sizeBytes:
                              type: number
                          required:
                            - path
                            - contentType
                            - sizeBytes
                            - entrypoint
                          type: object
                        type: array
                      kind:
                        enum:
                          - directory
                          - zip
                        type: string
                      path:
                        type: string
                      totalBytes:
                        type: number
                    required:
                      - kind
                      - path
                      - files
                      - totalBytes
                    type: object
                  links:
                    items:
                      additionalProperties: false
                      properties:
                        text:
                          type: string
                        url:
                          type: string
                      required:
                        - text
                        - url
                      type: object
                    type: array
                  page:
                    additionalProperties: false
                    properties:
                      artifact:
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                          versionId:
                            type: string
                          versionNumber:
                            type: number
                        required:
                          - id
                          - versionId
                          - versionNumber
                        type: object
                      description:
                        anyOf:
                          - type: string
                          - type: 'null'
                      file:
                        additionalProperties: false
                        properties:
                          contentType:
                            type: string
                          path:
                            type: string
                          sha256:
                            anyOf:
                              - type: string
                              - type: 'null'
                          sizeBytes:
                            anyOf:
                              - type: number
                              - type: 'null'
                        required:
                          - path
                          - contentType
                          - sizeBytes
                          - sha256
                        type: object
                      host:
                        type: string
                      path:
                        type: string
                      projectId:
                        type: string
                      release:
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                          number:
                            type: number
                        required:
                          - id
                          - number
                        type: object
                      route:
                        additionalProperties: false
                        properties:
                          id:
                            type: string
                          matchType:
                            type: string
                          path:
                            type: string
                        required:
                          - id
                          - path
                          - matchType
                        type: object
                      siteId:
                        type: string
                      title:
                        type: string
                      url:
                        type: string
                      visibility:
                        type: string
                    required:
                      - url
                      - host
                      - path
                      - title
                      - description
                      - visibility
                      - siteId
                      - projectId
                      - route
                      - release
                      - artifact
                      - file
                    type: object
                  publicOnly:
                    type: boolean
                  routes:
                    items:
                      additionalProperties: false
                      properties:
                        matchType:
                          type: string
                        path:
                          type: string
                        url:
                          type: string
                        visibility:
                          type: string
                      required:
                        - path
                        - matchType
                        - url
                        - visibility
                      type: object
                    type: array
                  signals:
                    additionalProperties: false
                    properties:
                      raviElements:
                        items:
                          type: string
                        type: array
                      renderSuggested:
                        type: boolean
                      scripts:
                        type: number
                      staticTextChars:
                        type: number
                    required:
                      - scripts
                      - raviElements
                      - staticTextChars
                      - renderSuggested
                    type: object
                  success:
                    const: true
                    type: boolean
                required:
                  - success
                  - consoleUrl
                  - publicOnly
                  - page
                  - content
                  - links
                  - routes
                  - signals
                  - contentTrust
                type: object
          description: Success — body conforms to the `@Returns` schema.
        '400':
          description: Bad request — body failed schema validation.
        '500':
          description: Internal error.
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.