> ## 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 chunk by chunk

> Every chunk with the analysis it produced, provenance intact. This is the debug view; the rolled-up output is what an agent reads.



## OpenAPI

````yaml /openapi/customer-api.json get /project/{projectId}/import/runs/{runId}/chunks
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}/chunks:
    get:
      tags:
        - Import
      summary: Read an import run chunk by chunk
      description: >-
        Every chunk with the analysis it produced, provenance intact. This is
        the debug view; the rolled-up output is what an agent reads.
      operationId: ImportController_runChunks
      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/ImportRunDetailDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    ImportRunDetailDto:
      properties:
        chunks:
          items:
            $ref: '#/components/schemas/ImportChunkResultDto'
          type: array
        progress:
          $ref: '#/components/schemas/ImportRunProgressDto'
      required:
        - progress
        - chunks
      type: object
    ImportChunkResultDto:
      properties:
        analysis:
          allOf:
            - $ref: '#/components/schemas/ChunkAnalysisDto'
          nullable: true
          type: object
        chunkId:
          type: string
        error:
          nullable: true
          type: string
        fileId:
          type: string
        filename:
          type: string
        inputTokens:
          type: number
        kind:
          enum:
            - pdf_page
            - image
          type: string
        outputTokens:
          type: number
        page:
          nullable: true
          type: number
        status:
          enum:
            - pending
            - running
            - done
            - failed
          type: string
      required:
        - chunkId
        - fileId
        - filename
        - kind
        - page
        - status
        - analysis
        - inputTokens
        - outputTokens
        - error
      type: object
    ImportRunProgressDto:
      properties:
        chunksDone:
          type: number
        chunksFailed:
          type: number
        chunksRunning:
          type: number
        chunksTotal:
          description: Null until planning has opened every file.
          nullable: true
          type: number
        completedAt:
          nullable: true
          type: string
        createdAt:
          type: string
        entityCount:
          type: number
        error:
          nullable: true
          type: string
        fileIds:
          description: Files the run was asked for, known before anything is opened.
          items:
            type: string
          type: array
        files:
          items:
            $ref: '#/components/schemas/ImportRunFileProgressDto'
          type: array
        inputTokens:
          type: number
        noteCount:
          type: number
        outputTokens:
          type: number
        relationshipCount:
          type: number
        runId:
          type: string
        status:
          enum:
            - queued
            - planning
            - running
            - succeeded
            - failed
            - cancelled
          type: string
      required:
        - runId
        - status
        - fileIds
        - chunksTotal
        - chunksDone
        - chunksRunning
        - chunksFailed
        - entityCount
        - relationshipCount
        - noteCount
        - inputTokens
        - outputTokens
        - files
        - error
        - createdAt
        - completedAt
      type: object
    ChunkAnalysisDto:
      properties:
        entities:
          items:
            $ref: '#/components/schemas/PageEntityDto'
          type: array
        notes:
          items:
            $ref: '#/components/schemas/PageNoteDto'
          type: array
        relationships:
          items:
            $ref: '#/components/schemas/PageRelationshipDto'
          type: array
      required:
        - entities
        - relationships
        - notes
      type: object
    ImportRunFileProgressDto:
      properties:
        chunksDone:
          type: number
        chunksFailed:
          type: number
        chunksTotal:
          type: number
        fileId:
          type: string
        filename:
          type: string
        kind:
          enum:
            - pdf_page
            - image
          type: string
      required:
        - fileId
        - filename
        - kind
        - chunksTotal
        - chunksDone
        - chunksFailed
      type: object
    PageEntityDto:
      properties:
        boxes:
          items:
            $ref: '#/components/schemas/PageBoxDto'
          type: array
        detail:
          description: What the page says this is — a requirement's statement.
          type: string
        name:
          type: string
        type:
          type: string
      required:
        - name
        - type
        - detail
        - boxes
      type: object
    PageNoteDto:
      properties:
        boxes:
          description: Where the difficulty arises.
          items:
            $ref: '#/components/schemas/PageBoxDto'
          type: array
        text:
          description: What this page raises but cannot settle.
          type: string
      required:
        - text
        - boxes
      type: object
    PageRelationshipDto:
      properties:
        from:
          type: string
        implied:
          description: False when the page states the relationship outright.
          type: boolean
        provenance:
          $ref: '#/components/schemas/PageProvenanceDto'
        to:
          type: string
        type:
          type: string
      required:
        - from
        - to
        - type
        - provenance
        - implied
      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
    PageProvenanceDto:
      properties:
        boxes:
          description: Where that evidence sits.
          items:
            $ref: '#/components/schemas/PageBoxDto'
          type: array
        text:
          description: The words or visual feature evidencing the link.
          type: string
      required:
        - text
        - boxes
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````