Microsoft Word Images API

openapi: 3.2.0
info:
  title: Microsoft Word Open XML SDK Images API
  description: RESTful representation of the Open XML SDK operations for Word document processing. Provides programmatic access to create, read, and manipulate Word documents (.docx) using the ECMA-376 Open XML standard without requiring Microsoft Office installation.
  version: 3.0.0
  contact:
    name: Microsoft Office Open XML Documentation
    url: https://learn.microsoft.com/en-us/office/open-xml/open-xml-sdk
  license:
    name: MIT License
    url: https://github.com/OfficeDev/Open-XML-SDK/blob/main/LICENSE
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
  x-api-type: SDK
servers:
- url: https://localhost:5000/api/v1
  description: Local Open XML processing service
tags:
- name: Images
  description: Operations for managing images in documents
paths:
  /documents/{document-id}/images:
    get:
      operationId: listImages
      summary: Microsoft Word List Images
      description: List all images embedded in the document.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/documentId'
      responses:
        '200':
          description: Successfully retrieved images.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCollection'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: addImage
      summary: Microsoft Word Add Image
      description: Add an image to the document.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/documentId'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                  description: Image file to add.
                width:
                  type: integer
                  description: Width of the image in EMUs.
                  example: 914400
                height:
                  type: integer
                  description: Height of the image in EMUs.
                  example: 685800
      responses:
        '201':
          description: Successfully added image.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageInfo'
        '400':
          $ref: '#/components/responses/BadRequest'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    BadRequest:
      description: Invalid request parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      description: Error response from the API.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code.
              example: DocumentNotFound
            message:
              type: string
              description: Human-readable error message.
              example: The specified document could not be found.
    ImageInfo:
      type: object
      description: Information about an embedded image.
      properties:
        relationshipId:
          type: string
          description: Relationship ID of the image part.
          example: rId4
        contentType:
          type: string
          description: MIME type of the image.
          example: image/png
        width:
          type: integer
          description: Width in EMUs.
          example: 914400
        height:
          type: integer
          description: Height in EMUs.
          example: 685800
    ImageCollection:
      type: object
      description: Collection of embedded images.
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ImageInfo'
        count:
          type: integer
          description: Total number of images.
          example: 5
  parameters:
    documentId:
      name: document-id
      in: path
      required: true
      description: The unique identifier of the document.
      schema:
        type: string
      example: doc-openxml-a1b2c3