Cloudmersive Transform Document API

Transform Document operations of the Cloudmersive Document and Data Conversion API — 6 operation(s) served from https://api.cloudmersive.com and authenticated with the Apikey header. One Cloudmersive API key grants access to every API in the portfolio.

Operations 6

POST /convert/transform/docx/replace-all Replace string in Word DOCX document, return result #
POST /convert/transform/docx/replace-all/edit-session Replace string in Word DOCX document, return edit session #
POST /convert/transform/docx/table/fill/data Fill in data in a table in a Word DOCX document, return result #
POST /convert/transform/docx/table/fill/data/edit-session Fill in data in a table in a Word DOCX document, return edit session #
POST /convert/transform/docx/table/fill/data/multi Fill in data in multiple tables in a Word DOCX document, return result #
POST /convert/transform/pptx/replace-all Replace string in PowerPoint PPTX presentation, return result #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudmersive:cloudmersive-transformdocument-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudmersive-transformdocument-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: v1
  title: convertapi Transform Document API
  description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: TransformDocument
paths:
  /convert/transform/docx/replace-all:
    post:
      tags:
      - TransformDocument
      summary: Replace string in Word DOCX document, return result
      description: Replace all instances of a string in an Office Word Document (docx)
      operationId: TransformDocument_DocxReplace
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).'
        required: false
        schema:
          type: string
      - name: matchString
        in: header
        description: String to search for and match against, to be replaced
        required: true
        schema:
          type: string
      - name: replaceString
        in: header
        description: String to replace the matched values with
        required: true
        schema:
          type: string
      - name: matchCase
        in: header
        description: 'Optional: True if the case should be matched, false for case insensitive match. Default is false.'
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/transform/docx/replace-all/edit-session:
    post:
      tags:
      - TransformDocument
      summary: Replace string in Word DOCX document, return edit session
      description: Replace all instances of a string in an Office Word Document (docx). Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
      operationId: TransformDocument_DocxReplaceEditSession
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).'
        required: false
        schema:
          type: string
      - name: matchString
        in: header
        description: String to search for and match against, to be replaced
        required: true
        schema:
          type: string
      - name: replaceString
        in: header
        description: String to replace the matched values with
        required: true
        schema:
          type: string
      - name: matchCase
        in: header
        description: 'Optional: True if the case should be matched, false for case insensitive match. Default is false.'
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
            application/xml:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
            text/xml:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/transform/docx/table/fill/data:
    post:
      tags:
      - TransformDocument
      summary: Fill in data in a table in a Word DOCX document, return result
      description: Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates
      operationId: TransformDocument_DocxTableFillIn
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
        required: true
  /convert/transform/docx/table/fill/data/edit-session:
    post:
      tags:
      - TransformDocument
      summary: Fill in data in a table in a Word DOCX document, return edit session
      description: Replace placeholder rows ina table in an Office Word Document (docx) using one or more templates. Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times. Call the Finish Editing API to retrieve the final document once editing is complete.
      operationId: TransformDocument_DocxTableFillInEditSession
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
            application/xml:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
            text/xml:
              schema:
                $ref: '#/components/schemas/DocumentTransformEditSession'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillRequest'
        required: true
  /convert/transform/docx/table/fill/data/multi:
    post:
      tags:
      - TransformDocument
      summary: Fill in data in multiple tables in a Word DOCX document, return result
      description: Replace placeholder rows in multiple tables in an Office Word Document (docx) using one or more templates
      operationId: TransformDocument_DocxTableFillInMulti
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillMultiRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillMultiRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillMultiRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillMultiRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DocxTableTableFillMultiRequest'
        required: true
  /convert/transform/pptx/replace-all:
    post:
      tags:
      - TransformDocument
      summary: Replace string in PowerPoint PPTX presentation, return result
      description: Replace all instances of a string in an Office PowerPoint Document (pptx)
      operationId: TransformDocument_PptxReplace
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).'
        required: false
        schema:
          type: string
      - name: matchString
        in: header
        description: String to search for and match against, to be replaced
        required: true
        schema:
          type: string
      - name: replaceString
        in: header
        description: String to replace the matched values with
        required: true
        schema:
          type: string
      - name: matchCase
        in: header
        description: 'Optional: True if the case should be matched, false for case insensitive match. Default is false.'
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
components:
  schemas:
    DocxTableSingleTableFill:
      description: Single table fill request in a multi-table fill operation
      type: object
      properties:
        TableStartTag:
          description: Start tag that delineates the beginning of the table
          type: string
        TableEndTag:
          description: End tag that delineates the end of the table
          type: string
        DataToFillIn:
          description: Data set to populate the table with
          type: array
          items:
            $ref: '#/components/schemas/DocxTableTableFillTableRow'
    DocxTableTableFillTableCell:
      description: Cell data to fill in to the DOCX Table
      type: object
      properties:
        TargetTag:
          description: Target tag to replace
          type: string
        ReplacementValue:
          description: Replacement value for the target tag
          type: string
    DocxTableTableFillTableRow:
      description: Row data to fill in to the DOCX Table
      type: object
      properties:
        Cells:
          description: Cells in the row to fill in
          type: array
          items:
            $ref: '#/components/schemas/DocxTableTableFillTableCell'
    DocxTableTableFillRequest:
      description: Request to update data in a table in a Word DOCX Document
      type: object
      properties:
        InputFileUrl:
          description: Optional; Input URL of the document; use BeginEditing to create this
          type: string
        InputFileData:
          format: byte
          description: Optional; Input Word Document file content for the operation
          type: string
        TableStartTag:
          description: Start tag that delineates the beginning of the table
          type: string
        TableEndTag:
          description: End tag that delineates the end of the table
          type: string
        DataToFillIn:
          description: Data set to populate the table with
          type: array
          items:
            $ref: '#/components/schemas/DocxTableTableFillTableRow'
    DocxTableTableFillMultiRequest:
      description: Request to update data in a table in a Word DOCX Document
      type: object
      properties:
        InputFileUrl:
          description: Optional; Input URL of the document; use BeginEditing to create this
          type: string
        InputFileData:
          format: byte
          description: Optional; Input Word Document file content for the operation
          type: string
        TablesToFill:
          description: Tables and datasets to fill into the document
          type: array
          items:
            $ref: '#/components/schemas/DocxTableSingleTableFill'
    DocumentTransformEditSession:
      description: Active document editing session result.  To retrieve the document, use the Finish Editing API.
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        EditSessionURL:
          description: Document editing session URL; in-memory temporary cache link with TTL (Time-to-Live expiration) of 30 minutes.  To retrieve the document, use the Finish Editing API.
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/convert/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)