SoftSync AI

SoftSync AI Documents API

The Documents API from SoftSync AI — 7 operation(s) for documents.

GitHub OpenAPI

Operations 10

GET /documents/templates List document templates, optionally for one object #
POST /documents/templates Create a document template #
GET /documents/templates/{id} Read a document template #
PUT /documents/templates/{id} Save a document template #
DELETE /documents/templates/{id} Move a document template to the bin #
POST /documents/preview A design filled from a record, as a PDF (nothing is saved) #
POST /documents/values Template values filled from a record, as plain text (nothing is saved) #
POST /documents/templates/{id}/generate Make a document from a record; the PDF is built in the background #
GET /documents/records/{recordId} Documents made from a record, newest first #
GET /documents/{id} Read a document and its status #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/softsync-ai/openapi/softsync-ai-documents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-enrich-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-query-messages-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-update-meeting-type-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-semantic-search-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-create-meeting-type-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-message-link-stats-query-dto-schema.json

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/softsync-ai:softsync-ai-documents-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

softsync-ai-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Softsync Documents API
  description: '## Introduction


    The Softsync Platform API


    This API lets you read and write your Softsync data from your own applications. Authenticate with a personal API key created in **Settings → API Keys**, sent as the `x-api-key` header.


    **New here?** Read **Concepts** first, then **Authentication**, then **Quickstart: full cycle** — it walks the whole thing end to end. **Objects**, **Records**, **Groups & Views** and **Notes** cover each area in depth, and **Code Generation** shows how to turn this document into a typed client.


    To try a request from this page, paste your API key into the **Authentication** panel on the right.


    ## Support


    If you need help with API access or integration details, contact contact@softsync.ai.'
  version: 0.1.0
  contact: {}
servers: []
security:
- x-api-key: []
tags:
- name: Documents
paths:
  /documents/templates:
    get:
      operationId: listDocumentTemplates
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: tableId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List document templates, optionally for one object
      tags:
      - Documents
      x-feature: documents
    post:
      operationId: createDocumentTemplate
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocumentTemplateDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Create a document template
      tags:
      - Documents
      x-feature: documents
  /documents/templates/{id}:
    get:
      operationId: getDocumentTemplate
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Read a document template
      tags:
      - Documents
      x-feature: documents
    put:
      operationId: updateDocumentTemplate
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveDocumentTemplateDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Save a document template
      tags:
      - Documents
      x-feature: documents
    delete:
      operationId: deleteDocumentTemplate
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: Moved to the bin
      security:
      - bearer: []
      summary: Move a document template to the bin
      tags:
      - Documents
      x-feature: documents
  /documents/preview:
    post:
      operationId: previewDocument
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: templateId
        required: true
        in: query
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewDocumentDto'
      responses:
        '200':
          description: The PDF
          content:
            application/pdf:
              schema:
                type: string
                format: binary
      security:
      - bearer: []
      summary: A design filled from a record, as a PDF (nothing is saved)
      tags:
      - Documents
      x-feature: documents
  /documents/values:
    post:
      operationId: documentValues
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentValuesDto'
      responses:
        '200':
          description: One filled-in text per value sent, in the same order
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - bearer: []
      summary: Template values filled from a record, as plain text (nothing is saved)
      tags:
      - Documents
      x-feature: documents
  /documents/templates/{id}/generate:
    post:
      operationId: generateDocument
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateDocumentDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentDto'
      security:
      - bearer: []
      summary: Make a document from a record; the PDF is built in the background
      tags:
      - Documents
      x-feature: documents
  /documents/records/{recordId}:
    get:
      operationId: listRecordDocuments
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: recordId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentDto'
      security:
      - bearer: []
      summary: Documents made from a record, newest first
      tags:
      - Documents
      x-feature: documents
  /documents/{id}:
    get:
      operationId: getDocument
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentDto'
      security:
      - bearer: []
      summary: Read a document and its status
      tags:
      - Documents
      x-feature: documents
components:
  schemas:
    DocumentDto:
      type: object
      properties:
        id:
          type: string
        templateId:
          type: string
        recordId:
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/DocumentStatus'
        error:
          type: string
          description: Why the PDF could not be made
        file:
          $ref: '#/components/schemas/FileAttachment'
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
      required:
      - id
      - templateId
      - recordId
      - status
      - createdAt
    GenerateDocumentDto:
      type: object
      properties:
        recordId:
          type: string
      required:
      - recordId
    DocumentValuesDto:
      type: object
      properties:
        recordId:
          type: string
        values:
          description: Template values, like {{ record.name }}
          type: array
          items:
            type: string
      required:
      - recordId
      - values
    SaveDocumentTemplateDto:
      type: object
      properties:
        title:
          type: string
        content:
          $ref: '#/components/schemas/DocumentContentDto'
        page:
          $ref: '#/components/schemas/DocumentPageDto'
        fileName:
          type: string
          description: File name, may use {{ … }} (e.g. "Invoice {{ record.number }}")
        outputFieldId:
          type: string
          description: A file field (id) on the record that also receives each new PDF
      required:
      - title
      - content
    PreviewDocumentDto:
      type: object
      properties:
        recordId:
          type: string
        content:
          $ref: '#/components/schemas/DocumentContentDto'
        page:
          $ref: '#/components/schemas/DocumentPageDto'
      required:
      - recordId
    CreateDocumentTemplateDto:
      type: object
      properties:
        title:
          type: string
        content:
          $ref: '#/components/schemas/DocumentContentDto'
        page:
          $ref: '#/components/schemas/DocumentPageDto'
        fileName:
          type: string
          description: File name, may use {{ … }} (e.g. "Invoice {{ record.number }}")
        outputFieldId:
          type: string
          description: A file field (id) on the record that also receives each new PDF
        groupId:
          type: string
        tableId:
          type: string
      required:
      - title
      - content
    DocumentMarginDto:
      type: object
      properties:
        top:
          type: number
        right:
          type: number
        bottom:
          type: number
        left:
          type: number
    DocumentStatus:
      type: string
      enum:
      - queued
      - done
      - failed
    PaperSize:
      type: string
      enum:
      - a4
      - a5
      - us-letter
      - us-legal
    DocumentPageDto:
      type: object
      properties:
        size:
          allOf:
          - $ref: '#/components/schemas/PaperSize'
        landscape:
          type: boolean
        margin:
          $ref: '#/components/schemas/DocumentMarginDto'
        header:
          type: string
        footer:
          type: string
        pageNumbers:
          type: boolean
    DocumentContentDto:
      type: object
      properties:
        blocks:
          type: array
          items:
            type: object
            additionalProperties: true
        settings:
          type: object
        pdf:
          type: object
      required:
      - blocks
    FileAttachment:
      type: object
      properties:
        id:
          type: string
        path:
          type: string
        fileName:
          type: string
        fileSize:
          type: number
        mime:
          type: string
        isInline:
          type: boolean
        contentId:
          type: string
        url:
          type: string
      required:
      - id
      - path
      - fileName
      - fileSize
      - mime
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key