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

# get_file_output

> Return a live derived-file output plus short-lived download URLs. Cost class: **fast**.

Only ``derived_file`` outputs live as objects in the workspace store.
Search-index and knowledge-graph outputs carry opaque keys and cannot be
fetched this way.



## OpenAPI

````yaml /openapi.json get /v1/workspaces/{workspace_id}/files/{file_id}/outputs/{output_id}
openapi: 3.1.0
info:
  description: >-
    Document intelligence: parse, split, classify, extract, and ground files, or
    build a searchable workspace. Authenticate with ``X-API-Key``.
  title: NDI Platform API
  version: 0.1.0
servers:
  - url: https://ndi-api.nace.ai
security: []
tags: []
paths:
  /v1/workspaces/{workspace_id}/files/{file_id}/outputs/{output_id}:
    get:
      tags:
        - files
      summary: get_file_output
      description: >-
        Return a live derived-file output plus short-lived download URLs. Cost
        class: **fast**.


        Only ``derived_file`` outputs live as objects in the workspace store.

        Search-index and knowledge-graph outputs carry opaque keys and cannot be

        fetched this way.
      operationId: >-
        get_file_output_v1_workspaces__workspace_id__files__file_id__outputs__output_id__get
      parameters:
        - in: path
          name: file_id
          required: true
          schema:
            format: uuid
            title: File Id
            type: string
        - in: path
          name: output_id
          required: true
          schema:
            format: uuid
            title: Output Id
            type: string
        - description: Workspace identifier.
          in: path
          name: workspace_id
          required: true
          schema:
            description: Workspace identifier.
            format: uuid
            title: Workspace Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactOutputDetail'
          description: Successful Response
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Gateway Timeout
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  detail: null
                  message: >-
                    Request body has extra fields that this operation does not
                    accept.
                  request_id: req-01j9k2n3p4q5r6s7t8v9
                  retryable: false
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: >-
            Typed error envelope used by every 4xx and 5xx. ``error.code``
            distinguishes the failure; HTTP status is a consequence of the code.
      security:
        - APIKeyHeader: []
components:
  schemas:
    ArtifactOutputDetail:
      additionalProperties: false
      description: >-
        A live ``derived_file`` output plus short-lived presigned URLs for its
        bytes.


        Search-index and knowledge-graph outputs are not downloadable this way —

        their ``path`` is an opaque index key, not an object in the workspace
        store.
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        download_url:
          description: >-
            Time-limited presigned GET URL that saves the derivative's bytes to
            disk.
          title: Download Url
          type: string
        download_url_expires_at:
          description: When the presigned URLs stop being valid.
          format: date-time
          title: Download Url Expires At
          type: string
        generation:
          description: The file version this output was produced from.
          title: Generation
          type: integer
        kind:
          $ref: '#/components/schemas/ArtifactOutputKind'
        output_id:
          format: uuid
          title: Output Id
          type: string
        path:
          title: Path
          type: string
        preview_url:
          description: Time-limited presigned GET URL that a browser renders inline.
          title: Preview Url
          type: string
      required:
        - output_id
        - kind
        - path
        - generation
        - created_at
        - download_url
        - preview_url
        - download_url_expires_at
      title: ArtifactOutputDetail
      type: object
    ErrorEnvelope:
      description: Every non-2xx body on ``/v1``.
      example:
        error:
          code: invalid_request
          detail: null
          message: Request body has extra fields that this operation does not accept.
          request_id: req-01j9k2n3p4q5r6s7t8v9
          retryable: false
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
      title: ErrorEnvelope
      type: object
    ArtifactOutputKind:
      description: Where a derivation landed, for the deletion cascade.
      enum:
        - opensearch_doc
        - kg_document
        - derived_file
      title: ArtifactOutputKind
      type: string
    Error:
      description: The error object, per spec 12 §1.8.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        detail:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: Structured payload, when the code carries one.
          title: Detail
        message:
          description: Human- and model-readable; says what to do differently.
          title: Message
          type: string
        request_id:
          description: Per-request correlation id; matches the ``X-Request-Id`` header.
          title: Request Id
          type: string
        retryable:
          description: Whether retrying the identical request could succeed.
          title: Retryable
          type: boolean
      required:
        - code
        - message
        - retryable
        - request_id
      title: Error
      type: object
    ErrorCode:
      description: |-
        Every error the ``/v1`` surface can return.

        Clients must treat this as an **open** enum: a new member is an additive
        change (spec 12 §9), and a client that crashes on an unknown code makes
        every future error a breaking change.
      enum:
        - invalid_request
        - unsupported_file_type
        - file_too_large
        - invalid_schema
        - invalid_sql
        - invalid_path_prefix
        - command_not_permitted
        - batch_too_large
        - domain_validation_failed
        - default_label_required
        - wait_required_for_zero_retention
        - workspace_not_found
        - file_not_found
        - job_not_found
        - upload_not_found
        - node_not_found
        - schema_not_found
        - domain_not_found
        - session_not_found
        - access_label_not_found
        - path_conflict
        - schema_version_conflict
        - access_label_name_taken
        - workspace_name_taken
        - access_label_in_use
        - upload_expired
        - file_not_ingested
        - workspace_deleting
        - workspace_not_deletable
        - ingestion_in_progress
        - job_not_cancellable
        - confirmation_required
        - domain_not_published
        - domain_in_use
        - reserved_domain_slug
        - kg_not_built
        - kg_build_in_progress
        - session_busy
        - range_not_satisfiable
        - result_expired
        - access_denied
        - access_backstop_violation
        - access_mode_not_implemented
        - rate_limited
        - concurrency_limit_reached
        - quota_exceeded
        - corrupt_file
        - zero_byte_file
        - encrypted_file
        - parse_failed
        - ocr_failed
        - conversion_failed
        - sheetless_workbook
        - unplayable_media
        - unclassified_pages
        - job_cancelled
        - job_timeout
        - upstream_unavailable
        - internal_error
        - unauthorized
        - not_implemented
      title: ErrorCode
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````