TurboDocx

TurboDocx Deliverable API

The Deliverable API from TurboDocx — 4 operation(s) for deliverable.

GitHub OpenAPI

Operations 7

GET /v1/deliverable GET /v1/deliverable #
POST /v1/deliverable POST /v1/deliverable #
DELETE /v1/deliverable/{id} Delete a deliverable (soft delete) #
GET /v1/deliverable/{id} Get a single deliverable #
PATCH /v1/deliverable/{id} Update a deliverable #
GET /v1/deliverable/file/{deliverableid} Download source file (DOCX/PPTX) #
GET /v1/deliverable/file/pdf/{deliverableid} Download PDF file #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/turbodocx/openapi/turbodocx-deliverable-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/turbodocx/json-schema/turbodocx-get-template-templateid-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/turbodocx/json-schema/turbodocx-get-api-webhooks-signature-stats-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/turbodocx/json-schema/turbodocx-get-v1-deliverable-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/turbodocx/json-schema/turbodocx-post-v1-deliverable-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/turbodocx/json-schema/turbodocx-get-tag-id-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/turbodocx/json-schema/turbodocx-get-api-webhooks-signature-response-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/turbodocx/apis.yml

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/turbodocx:turbodocx-deliverable-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.

GitHub Google LinkedIn

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

OpenAPI Specification

turbodocx-deliverable-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: TurboDocx Deliverable API
  version: '2026-11-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-02: 20 operation(s) read from 13 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; TurboDocx has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 19
    documentation: 1
    pages-with-code: 13
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.turbodocx.com/docs/API/read-tag
  - https://docs.turbodocx.com/docs/API/create-tag
  - https://docs.turbodocx.com/docs/API/update-tag
  - https://docs.turbodocx.com/docs/API/get-webhook
  - https://docs.turbodocx.com/docs/API/test-webhook
  - https://docs.turbodocx.com/docs/API/create-webhook
  - https://docs.turbodocx.com/docs/API/delete-webhook
  - https://docs.turbodocx.com/docs/API/notify-webhook
  - https://docs.turbodocx.com/docs/API/update-webhook
  - https://docs.turbodocx.com/docs/API/Deliverable-API
  - https://docs.turbodocx.com/docs/API/delete-template
  - https://docs.turbodocx.com/docs/API/get-webhook-stats
  - https://docs.turbodocx.com/docs/API/get-template-by-id
servers:
- url: https://api.turbodocx.com
security:
- bearer: []
tags:
- name: Deliverable
paths:
  /v1/deliverable:
    get:
      operationId: get_v1_deliverable
      tags:
      - Deliverable
      summary: GET /v1/deliverable
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      - name: offset
        in: query
        required: false
        schema:
          type: string
      - name: showTags
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1DeliverableResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET \"https://api.turbodocx.com/v1/deliverable?limit=10&offset=0&showTags=true\" \\ -H \"Authorization: Bearer YOUR_API_TOKEN\" \\ -H \"x-rapiddocx-org-id: YOUR_ORGANIZATION_ID\" \n Response ​ \n { \"data\" : { \"results\" : [ { \"id\" : \"39697685-ca00-43b8-92b8-7722544c574f\" , \"name\" : \"Employee Contract - John Smith\" , \"description\" : \"Employment contract for senior developer\" , \"templateId\" : \"0b1099cf"
    post:
      operationId: post_v1_deliverable
      tags:
      - Deliverable
      summary: POST /v1/deliverable
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1DeliverableRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1DeliverableResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST "https://api.turbodocx.com/v1/deliverable" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "x-rapiddocx-org-id: YOUR_ORGANIZATION_ID" \ -H "Content-Type: application/json" \ -d ''{ "templateId": "YOUR_TEMPLATE_ID", "name": "My Document", "variables": [ { "placeholder": "{CompanyName}", "text": "Acme Corporation", "mimeType": "text" } ] }'' # 2. Download the source file (DOCX/PPTX) curl'
  /v1/deliverable/{id}:
    delete:
      operationId: delete_v1_deliverable_id
      tags:
      - Deliverable
      summary: Delete a deliverable (soft delete)
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteV1DeliverableIdResponse'
      x-evidence:
        kind: documentation
    get:
      operationId: get_v1_deliverable_id
      tags:
      - Deliverable
      summary: Get a single deliverable
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: showTags
        in: query
        required: false
        schema:
          type: boolean
        description: Include tags in the response
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1DeliverableIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_v1_deliverable_id
      tags:
      - Deliverable
      summary: Update a deliverable
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchV1DeliverableIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchV1DeliverableIdResponse'
      x-evidence:
        kind: documentation
  /v1/deliverable/file/{deliverableid}:
    get:
      operationId: get_v1_deliverable_file_deliverableid
      tags:
      - Deliverable
      summary: Download source file (DOCX/PPTX)
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      parameters:
      - name: deliverableid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1DeliverableFileDeliverableidResponse'
      x-evidence:
        kind: documentation
  /v1/deliverable/file/pdf/{deliverableid}:
    get:
      operationId: get_v1_deliverable_file_pdf_deliverableid
      tags:
      - Deliverable
      summary: Download PDF file
      x-source: https://docs.turbodocx.com/docs/API/Deliverable-API
      parameters:
      - name: deliverableid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1DeliverableFilePdfDeliverableidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PatchV1DeliverableIdResponse:
      type: object
      properties:
        data.message:
          type: string
          description: Success confirmation message
        data.deliverableId:
          type: string
          description: ID of the updated deliverable
    GetV1DeliverableIdResponse:
      type: object
      properties:
        data.results:
          type: object
          description: Deliverable details
    GetV1DeliverableFilePdfDeliverableidResponse:
      type: object
      properties:
        binary:
          type: string
          description: Binary PDF content
    DeleteV1DeliverableIdResponse:
      type: object
      properties:
        data.message:
          type: string
          description: Success confirmation message
        data.deliverableId:
          type: string
          description: ID of the deleted deliverable
    PostV1DeliverableRequest:
      type: object
      properties:
        templateId:
          type: string
        name:
          type: string
        variables:
          type: array
          items:
            type: object
            properties:
              placeholder:
                type: string
              text:
                type: string
              mimeType:
                type: string
    PatchV1DeliverableIdRequest:
      type: object
      properties:
        name:
          type: string
          description: Updated name (3–255 characters)
        description:
          type: string
          description: Updated description (up to 65,535 characters)
        tags:
          type: array
          description: Replace all tags (existing tags are removed first)
    GetV1DeliverableResponse:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              description:
                type: string
              templateId:
                type: string
              createdBy:
                type: string
              email:
                type: string
              fileSize:
                type: integer
              fileType:
                type: string
              defaultFont:
                type: string
              fonts:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    usage:
                      type: string
              isActive:
                type: boolean
              createdOn:
                type: string
                format: date-time
              updatedOn:
                type: string
                format: date-time
              tags:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    label:
                      type: string
                    isActive:
                      type: boolean
                    updatedOn:
                      type: string
                      format: date-time
                    createdOn:
                      type: string
                      format: date-time
                    createdBy:
                      type: string
                    orgId:
                      type: string
        totalRecords:
          type: integer
    PostV1DeliverableResponse:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              description:
                type: string
              templateId:
                type: string
              createdBy:
                type: string
              email:
                type: string
              fileSize:
                type: integer
              fileType:
                type: string
              defaultFont:
                type: string
              fonts:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    usage:
                      type: string
              isActive:
                type: boolean
              createdOn:
                type: string
                format: date-time
              updatedOn:
                type: string
                format: date-time
              tags:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    label:
                      type: string
                    isActive:
                      type: boolean
                    updatedOn:
                      type: string
                      format: date-time
                    createdOn:
                      type: string
                      format: date-time
                    createdBy:
                      type: string
                    orgId:
                      type: string
        totalRecords:
          type: integer
    GetV1DeliverableFileDeliverableidResponse:
      type: object
      properties:
        binary:
          type: string
          description: Binary content of the generated document
  securitySchemes:
    bearer:
      type: http
      scheme: bearer