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

# Read an import run rolled up across its chunks

> Candidate entities merged by name, carrying every type they were called and everything the pages said about them, relationships merged by their ends, and the notes each chunk left. Readable before the run settles; it then covers only the chunks read so far.



## OpenAPI

````yaml /openapi/customer-api.json get /project/{projectId}/import/runs/{runId}/output
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /project/{projectId}/import/runs/{runId}/output:
    get:
      tags:
        - Import
      summary: Read an import run rolled up across its chunks
      description: >-
        Candidate entities merged by name, carrying every type they were called
        and everything the pages said about them, relationships merged by their
        ends, and the notes each chunk left. Readable before the run settles; it
        then covers only the chunks read so far.
      operationId: ImportController_runOutput
      parameters:
        - in: path
          name: projectId
          required: true
          schema:
            type: string
        - in: path
          name: runId
          required: true
          schema:
            type: string
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportRunOutputDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    ImportRunOutputDto:
      properties:
        entities:
          items:
            $ref: '#/components/schemas/ImportCandidateEntityDto'
          type: array
        notes:
          items:
            $ref: '#/components/schemas/ImportRunNoteDto'
          type: array
        relationships:
          items:
            $ref: '#/components/schemas/ImportCandidateRelationshipDto'
          type: array
        runId:
          type: string
        status:
          enum:
            - queued
            - planning
            - running
            - succeeded
            - failed
            - cancelled
          type: string
      required:
        - runId
        - status
        - entities
        - relationships
        - notes
      type: object
    ImportCandidateEntityDto:
      properties:
        details:
          description: >-
            Everything the pages said this is — a requirement's statement, a
            design value's quantity.
          items:
            type: string
          type: array
        mentions:
          items:
            $ref: '#/components/schemas/ImportProvenanceDto'
          type: array
        name:
          type: string
        types:
          description: Every type the run called this name, in the source's words.
          items:
            type: string
          type: array
      required:
        - name
        - types
        - details
        - mentions
      type: object
    ImportRunNoteDto:
      properties:
        mention:
          $ref: '#/components/schemas/ImportProvenanceDto'
        text:
          type: string
      required:
        - text
        - mention
      type: object
    ImportCandidateRelationshipDto:
      properties:
        evidence:
          items:
            type: string
          type: array
        from:
          type: string
        implied:
          description: True when every sighting read it off layout, not words.
          type: boolean
        mentions:
          items:
            $ref: '#/components/schemas/ImportProvenanceDto'
          type: array
        to:
          type: string
        type:
          type: string
      required:
        - from
        - to
        - type
        - implied
        - evidence
        - mentions
      type: object
    ImportProvenanceDto:
      properties:
        boxes:
          items:
            $ref: '#/components/schemas/PageBoxDto'
          type: array
        chunkId:
          type: string
        fileId:
          type: string
        filename:
          type: string
        page:
          description: 1-based page for a PDF chunk, null for a whole image.
          nullable: true
          type: number
      required:
        - chunkId
        - fileId
        - filename
        - page
        - boxes
      type: object
    PageBoxDto:
      properties:
        height:
          description: Height as a fraction of page height.
          type: number
        width:
          description: Width as a fraction of page width.
          type: number
        x:
          description: Left edge as a fraction of page width.
          type: number
        'y':
          description: Top edge as a fraction of page height.
          type: number
      required:
        - x
        - 'y'
        - width
        - height
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````