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

# Get File Metadata

> Retrieve metadata for a single file including checksum, download count, and custom metadata.



## OpenAPI

````yaml GET /api/v1/files/{file_id}/metadata
openapi: 3.0.3
info:
  title: Uplint API
  version: 0.1.0
  description: >-
    Uplint is a file safety and integrity platform. Upload files through
    context-aware pipelines that automatically validate integrity, detect blank
    or placeholder content, and scan for viruses — all behind a single API.


    This specification covers the core Uplint REST API:


    - **API Keys** — Create and manage scoped API keys for programmatic access.

    - **File Contexts** — Define upload pipelines with per-context rules
    (allowed extensions, size limits, blank/corrupt rejection, virus scanning,
    rate limits, and storage quotas).

    - **Files** — Upload, list, download, inspect, and delete files. Every
    upload runs through the validation pipeline configured on its context.


    All endpoints are tenant-scoped. Authenticate with an API key or JWT token
    via the `Authorization` header.
  contact:
    name: Uplint Team
    url: https://uplint.dev
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.uplint.dev
    description: Production
  - url: http://localhost:8000
    description: Local development
security:
  - BearerAuth: []
tags:
  - name: API Keys
    description: >-
      Create, list, inspect, update, and revoke API keys. Each key carries
      scoped permissions (`upload`, `download`, `metadata`, `delete`, `admin`)
      and is bound to the authenticated tenant.
  - name: File Contexts
    description: >-
      File contexts define upload pipelines. Each context specifies allowed
      extensions, max file size, whether to reject blank or corrupt files, virus
      scanning, rate limits, and storage quotas. Files are always uploaded into
      a context.
  - name: Files
    description: >-
      Upload, list, download, inspect metadata, and delete files. Every upload
      is validated against its context rules before storage.
  - name: Storage Buckets
    description: >-
      Manage the S3 buckets a tenant stores files in. Each tenant can register
      multiple buckets (bring-your-own S3 credentials); one is the **default**
      (fallback) bucket, and file contexts can be routed to any active bucket.
      All storage endpoints require an `admin`-scoped API key.
paths:
  /api/v1/files/{file_id}/metadata:
    get:
      tags:
        - Files
      summary: Get file metadata
      description: >-
        Retrieve metadata for a single file including checksum, download count,
        and custom metadata.
      operationId: getFileMetadata
      parameters:
        - $ref: '#/components/parameters/FileId'
      responses:
        '200':
          description: File metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse_FileMetadata'
              example:
                status: SUCCESS
                message: File metadata retrieved
                data:
                  file_id: 6612f1a2c3b4d5e6f7890abc
                  original_filename: report.pdf
                  content_type: application/pdf
                  size_bytes: 843776
                  context_key: patient_reports
                  checksum: >-
                    sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
                  metadata:
                    department: radiology
                  download_count: 3
                  last_downloaded_at: '2026-02-10T10:30:00Z'
                timestamp: '2026-02-10T12:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    FileId:
      name: file_id
      in: path
      required: true
      schema:
        type: string
      description: The file's unique identifier.
  schemas:
    SuccessResponse_FileMetadata:
      type: object
      properties:
        status:
          type: string
          enum:
            - SUCCESS
        message:
          type: string
        data:
          $ref: '#/components/schemas/FileMetadataResponse'
        timestamp:
          type: string
          format: date-time
    FileMetadataResponse:
      type: object
      properties:
        file_id:
          type: string
        original_filename:
          type: string
        content_type:
          type: string
        size_bytes:
          type: integer
        context_key:
          type: string
        checksum:
          type: string
          description: SHA-256 checksum.
        metadata:
          type: object
          additionalProperties: true
        download_count:
          type: integer
          default: 0
        last_downloaded_at:
          type: string
          format: date-time
          nullable: true
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - ERROR
        message:
          type: string
        errors:
          type: array
          items:
            type: string
        timestamp:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: Missing, invalid, or expired authentication credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: ERROR
            message: Invalid or missing API key
            errors:
              - Authentication required
            timestamp: '2026-02-10T12:00:00Z'
    NotFound:
      description: The requested resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: ERROR
            message: Resource not found
            errors:
              - Not found
            timestamp: '2026-02-10T12:00:00Z'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass an API key or JWT token. API keys can be sent as `Authorization:
        Bearer <key>` or `Authorization: <key>`.

````