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

# Fetch the raw text of a source file from the mz store

> Serves content referenced by evidence whose `source` is
`header_declared` or `spdx_tag` (detections inside source files).

Only registered when `sources_kb` is set in the server config. When
omitted, this endpoint returns 404 at the router level and the
`evidence_url` field in license responses keeps pointing at the
externally-hosted SCANOSS file-contents endpoint.




## OpenAPI

````yaml /api-reference/developer-tools/v3-openapi.yaml get /v3/file-contents/{id}
openapi: 3.0.3
info:
  title: SCANOSS Services API
  version: 0.28.1
  description: |
    Consolidated HTTP API for the SCANOSS knowledge base. Exposes the
    following domains under a single `/v3/*` prefix:

      * **licenses**      — attribution files + per-file license evidence
      * **copyright**     — copyright evidence + holders (stubbed pending data)
      * **components**    — free-form search, versions and lifecycle status
      * **crypto**        — algorithms, hints and version ranges per purl,
                            plus ruleset tarball downloads
      * **crypto reachability** — stitched cryptographic findings, call
                            chains, entry points, supporting and forward
                            calls per component or frozen dependency tree
      * **dependencies**  — declared dependencies (with composite-license
                            resolution) and bounded transitive walks
      * **geo**           — contributor declared/curated locations and
                            timezone-based origin distribution
      * **vulnerabilities** (path `/vuln/*`) — CVE detection by merging the
                            local NVD KB with osv.dev, enriched with EPSS
      * **scan**          — direct SCANOSS engine scans (WFP upload, MD5 /
                            urlhash / snippet lookups)
      * **contents**      — raw notice / source-code content from the mz store

    Every batch endpoint encodes per-item failures as `info_code` /
    `info_message` so the call as a whole returns 200 with a
    `status.status` ∈ {SUCCESS, PARTIAL_SUCCESS, ERROR}. Single-purl
    GETs derive the same status from the item's `info_code`.
servers:
  - url: https://api.scanoss.com
    description: Production
security: []
tags:
  - name: licenses
    description: License attribution files and per-file license evidence
  - name: copyright
    description: Copyright evidence and holders (stubbed pending KB data)
  - name: components
    description: Component search, versions and lifecycle status
  - name: cryptography
    description: Cryptographic algorithms, hints, version ranges and ruleset downloads
  - name: cryptography-reachability
    description: >
      Crypto reachability over mining results: stitched findings, call chains,
      crypto entry points, supporting calls and bounded forward calls, for one
      component (with its mined dependency closure) or a caller-supplied frozen
      dependency tree. Registered only when reachability_db.dsn is configured.
  - name: dependencies
    description: Declared dependencies (per component) and transitive walks
  - name: geoprovenance
    description: Contributor locations (declared + curated) and origin distribution
  - name: vulnerabilities
    description: CVE detection (local KB + OSV) and CPE lookup
  - name: scan
    description: >
      Direct SCANOSS engine scans (passthrough), plus MD5 / urlhash / snippet
      lookups, and the dual-mode batch endpoint (synchronous single-shot WFP and
      chunked-async upload over the batchScanner pipeline). Registered only when
      scan.engine_path is configured.
  - name: contents
    description: Raw notice / source-code content from the mz store
paths:
  /v3/file-contents/{id}:
    get:
      tags:
        - contents
      summary: Fetch the raw text of a source file from the mz store
      description: |
        Serves content referenced by evidence whose `source` is
        `header_declared` or `spdx_tag` (detections inside source files).

        Only registered when `sources_kb` is set in the server config. When
        omitted, this endpoint returns 404 at the router level and the
        `evidence_url` field in license responses keeps pointing at the
        externally-hosted SCANOSS file-contents endpoint.
      operationId: getFileContent
      parameters:
        - $ref: '#/components/parameters/ContentIdPath'
        - $ref: '#/components/parameters/StartLineQuery'
        - $ref: '#/components/parameters/EndLineQuery'
      responses:
        '200':
          description: |
            File text as plain text. When `start` and/or `end` are present
            the response is sliced to that 1-based inclusive line range.
          content:
            text/plain:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          description: File not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                status: error
                error:
                  code: FILE_NOT_FOUND
                  message: content not found in mz store
                timestamp: '2026-05-19T11:39:56Z'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    ContentIdPath:
      in: path
      name: id
      required: true
      schema:
        type: string
        pattern: ^([0-9a-fA-F]{16}|[0-9a-fA-F]{32})$
      description: >-
        Content hash — 32-char hex MD5 or 16-char hex CRC64, per the knowledge
        base's key type.
      example: 2996ae3ec0d72a726e09c414f77f0992
    StartLineQuery:
      in: query
      name: start
      required: false
      schema:
        type: integer
        minimum: 1
      description: 1-based inclusive start line. Defaults to 1 when omitted.
    EndLineQuery:
      in: query
      name: end
      required: false
      schema:
        type: integer
        minimum: 1
      description: 1-based inclusive end line. Defaults to last line when omitted.
  responses:
    BadRequest:
      description: Invalid request parameters or body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            status: error
            error:
              code: INVALID_QUERY
              message: purl query parameter is required
            timestamp: '2026-05-19T11:39:56Z'
    InternalError:
      description: Unexpected server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            status: error
            error:
              code: INTERNAL_ERROR
              message: ...
            timestamp: '2026-05-19T11:39:56Z'
  schemas:
    ErrorBody:
      type: object
      required:
        - status
        - error
        - timestamp
      properties:
        status:
          type: string
          enum:
            - error
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: |
                Stable machine-readable error identifier. Possible values:
                  - INVALID_BODY, INVALID_QUERY, INVALID_FILE_HASH, INVALID_RANGE
                  - EMPTY_BATCH
                  - INVALID_PURL, COMPONENT_NOT_FOUND, VERSION_NOT_FOUND
                  - NOTICE_NOT_FOUND, FILE_NOT_FOUND, MZ_READ_FAILED
                  - TIMEOUT, INTERNAL_ERROR
            message:
              type: string
        timestamp:
          type: string
          format: date-time

````

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