SoftSync AI File API

openapi: 3.2.0
info:
  title: Softsync File 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: File
paths:
  /file/workspace/upload:
    post:
      operationId: uploadWorkspaceFile
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
                  description: The file, up to 100 MB
      responses:
        '201':
          description: File uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentDto'
      security:
      - bearer: []
      summary: Upload a file to workspace storage
      tags:
      - File
      x-feature: files
  /file/{path}:
    get:
      operationId: downloadFile
      parameters:
      - name: path
        required: true
        in: path
        schema:
          type: array
          items:
            type: string
      - name: download
        required: false
        in: query
        description: Stream attachment bytes through the API instead of redirecting to storage.
        schema:
          enum:
          - '1'
          type: string
      responses:
        '200':
          description: Attachment bytes when download=1
        '302':
          description: Redirect to Blob Storage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadRedirectDto'
      security:
      - bearer: []
      summary: Download a file by path
      tags:
      - File
      x-feature: files
components:
  schemas:
    AttachmentDto:
      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
    DownloadRedirectDto:
      type: object
      properties:
        url:
          type: string
        statusCode:
          type: number
      required:
      - url
      - statusCode
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key