> ## 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.

# Parse a ReqIF document into a flow-shaped preview

> Resolves a ReqIF document against an optional import mapping and returns the entities it describes (identifier, flow type, field values — with XHTML fields converted to rich-text JSON), the hierarchy/relation links, and the file-derived default schema. No entities are created; this is a read-only preview of what an import would produce.



## OpenAPI

````yaml /openapi/customer-api.json post /reqif/parse
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:
  /reqif/parse:
    post:
      tags:
        - ReqIF
      summary: Parse a ReqIF document into a flow-shaped preview
      description: >-
        Resolves a ReqIF document against an optional import mapping and returns
        the entities it describes (identifier, flow type, field values — with
        XHTML fields converted to rich-text JSON), the hierarchy/relation links,
        and the file-derived default schema. No entities are created; this is a
        read-only preview of what an import would produce.
      operationId: ReqifController_parse
      parameters:
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParseReqifDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  defaultSchema:
                    type: object
                  entities:
                    items:
                      properties:
                        identifier:
                          type: string
                        type:
                          type: string
                        values:
                          type: object
                      type: object
                    type: array
                  links:
                    items:
                      items:
                        type: string
                      type: array
                    type: array
                type: object
          description: Parsed entities, links and the file-derived default schema
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    ParseReqifDto:
      properties:
        mapping:
          description: >-
            Optional import mapping that renames reqif types/fields to flow
            names and configures per-field behaviour (extract_string,
            multiple_choice, convert_to, enum tag renames). Omit to use the
            reqif names verbatim (equivalent to the file-derived default
            schema).
          type: object
        reqif:
          description: >-
            The ReqIF document XML to parse. Either the raw contents of a .reqif
            file or the body of its CORE-CONTENT — the parser reads DATATYPES,
            SPEC-TYPES, SPEC-OBJECTS, SPECIFICATIONS and SPEC-RELATIONS.
          type: string
      required:
        - reqif
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````