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

# Get a rendered view of a file in a project's git repository

> Render a file from the project's main repository or from one of its imported repositories as HTML, for formats Domino knows how to render such as Markdown and notebooks. The HTML is produced from repository content and can carry active markup such as script tags, so treat it as untrusted: sanitize or sandbox it before inserting it into a page. Images and links in it point at Domino's internal raw file route, which is not part of the public contract and may change. Required permissions: `ListProject`



## OpenAPI

````yaml /api-specs/cloud/public-api.json get /api/projects/v1/projects/{projectId}/repositories/{repositoryId}/rendered-file
openapi: 3.0.3
info:
  title: Domino Public API
  description: Reference for Domino's public REST API endpoints.
  version: 6.4.0
  x-catalog-key: nucleus
servers:
  - url: https://mycluster.domino.tech
    description: >-
      Replace 'mycluster.domino.tech' with your Domino cluster hostname. For
      Domino Cloud customers, that is `your-subdomain`.domino.tech (e.g.,
      acme.domino.tech). For self-hosted deployments, it is the hostname you
      reach the Domino UI at.
security: []
tags:
  - name: Projects
  - name: Project templates
  - name: Workspaces
  - name: Jobs
  - name: HPC Jobs
  - name: Environments
  - name: Hardware Tiers
  - name: Datasets
  - name: Data Sources
  - name: GenAI
  - name: AI Systems
  - name: Apps
  - name: App versions
  - name: App instances
  - name: Model APIs
  - name: Registered models
  - name: Model deployment
  - name: Extensions
  - name: Cost and billing
  - name: Users and organizations
  - name: Service accounts
  - name: Personal Access Tokens
  - name: Personal Access Tokens (admin)
  - name: Audit Trail
  - name: Custom metrics
  - name: PPM
  - name: Model Monitoring models
  - name: Model Monitoring drift and quality
  - name: Model Monitoring settings
  - name: Model Monitoring authentication
  - name: Governance bundles
  - name: Governance policies
  - name: Governance evidence and results
  - name: Governance operations
  - name: NetApp Volumes
  - name: NetApp Volumes snapshots
  - name: NetApp Volumes filesystems
  - name: NetApp Volumes transfers
  - name: Tags
  - name: Properties
externalDocs:
  description: OpenAPI
  url: https://swagger.io/resources/open-api/
paths:
  /api/projects/v1/projects/{projectId}/repositories/{repositoryId}/rendered-file:
    get:
      tags:
        - Projects
      summary: Get a rendered view of a file in a project's git repository
      description: >-
        Render a file from the project's main repository or from one of its
        imported repositories as HTML, for formats Domino knows how to render
        such as Markdown and notebooks. The HTML is produced from repository
        content and can carry active markup such as script tags, so treat it as
        untrusted: sanitize or sandbox it before inserting it into a page.
        Images and links in it point at Domino's internal raw file route, which
        is not part of the public contract and may change. Required permissions:
        `ListProject`
      operationId: getRenderedRepositoryFile
      parameters:
        - description: ID of the project the repository belongs to
          in: path
          name: projectId
          required: true
          schema:
            type: string
        - description: >-
            ID of the repository being queried. Use `_` to refer to the
            project's main repository.
          in: path
          name: repositoryId
          required: true
          schema:
            type: string
        - description: Path of the file within the repository
          in: query
          name: fileName
          required: true
          schema:
            type: string
        - description: >-
            Branch to read the file from. Defaults to the project's default git
            branch.
          in: query
          name: branchName
          required: false
          schema:
            type: string
        - description: Commit SHA to read the file at. Takes precedence over branchName.
          in: query
          name: commit
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitRenderedFileEnvelopeV1'
          description: Success
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      security:
        - DominoApiKey: []
        - BearerAuthentication: []
components:
  schemas:
    GitRenderedFileEnvelopeV1:
      properties:
        metadata:
          $ref: '#/components/schemas/MetadataV1'
        renderedFile:
          $ref: '#/components/schemas/GitRenderedFileV1'
      required:
        - renderedFile
        - metadata
      type: object
    MetadataV1:
      properties:
        notices:
          description: Notices relating to the request
          items:
            type: string
          type: array
        requestId:
          type: string
      required:
        - requestId
        - notices
      type: object
    GitRenderedFileV1:
      properties:
        html:
          description: >
            The file rendered as an HTML fragment. Produced from repository
            content, so it can carry active markup such as script tags or event
            handlers. Sanitize or sandbox it before inserting it into a page.
          type: string
      required:
        - html
      type: object
    ErrorV1:
      properties:
        code:
          description: Machine-readable error code.
          example: NOT_FOUND
          type: string
        message:
          description: Human-readable description of the error.
          example: The requested HPC Job could not be found.
          type: string
      required:
        - message
      type: object
  responses:
    '400':
      content:
        application/json:
          schema:
            properties:
              error:
                type: string
            type: object
      description: Bad Request
    '401':
      content:
        application/json:
          example:
            code: UNAUTHORIZED
            message: Authentication is required to access this resource.
          schema:
            $ref: '#/components/schemas/ErrorV1'
      description: Unauthorized - authentication is required or has failed.
    '403':
      content:
        application/json:
          example:
            code: FORBIDDEN
            message: You do not have permission to perform this action.
          schema:
            $ref: '#/components/schemas/ErrorV1'
      description: Forbidden - the caller lacks permission to perform this action.
    '404':
      content:
        application/json:
          schema:
            properties:
              error:
                type: string
            type: object
      description: Not Found
    '500':
      content:
        application/json:
          schema:
            properties:
              error:
                type: string
            type: object
      description: Internal Server Error
  securitySchemes:
    DominoApiKey:
      type: apiKey
      in: header
      name: X-Domino-Api-Key
    BearerAuthentication:
      type: apiKey
      name: Authorization
      in: header

````

## Related topics

- [Domino Cloud release notes](/release-notes/cloud-release.md)
- [Projects](/cloud/platform-capabilities/core-concepts/projects/index.md)
- [Get metadata about a file in a project's git repository](/api-reference/projects/get-metadata-about-a-file-in-a-projects-git-repository.md)
- [Get the name of the readme file in a project's git repository](/api-reference/projects/get-the-name-of-the-readme-file-in-a-projects-git-repository.md)
