SoftSync AI Public API

openapi: 3.2.0
info:
  title: Softsync Public 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: Public
paths:
  /openapi/workflows:
    get:
      operationId: listPublishedWorkflows
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PublicWorkflowSummaryDto'
      security:
      - bearer: []
      summary: List workflows this workspace publishes as API endpoints
      tags:
      - Public
      x-feature: workflows
  /openapi/workflows/runs/{runId}:
    get:
      operationId: getPublishedWorkflowRun
      parameters:
      - name: runId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunPublicWorkflowResponseDto'
      security:
      - bearer: []
      summary: Get the status/result of a published-workflow run
      tags:
      - Public
      x-feature: workflows
  /openapi/workflows/{slug}/run:
    post:
      description: Body is validated against the workflow input schema. `mode=sync` (default) waits up to 60s and returns the output; `mode=async` (or a sync timeout) responds 202 with a runId to poll. Send an Idempotency-Key header to make retries safe.
      operationId: runPublishedWorkflow
      parameters:
      - name: slug
        required: true
        in: path
        schema:
          type: string
      - name: mode
        required: true
        in: query
        schema:
          type: string
      - name: timeoutMs
        required: true
        in: query
        schema:
          type: string
      - name: idempotency-key
        required: true
        in: header
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunPublicWorkflowResponseDto'
        '202':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunPublicWorkflowResponseDto'
      security:
      - bearer: []
      summary: Run a published workflow by slug
      tags:
      - Public
      x-feature: workflows
  /openapi/workspaces/{workspaceId}/workflows.json:
    get:
      operationId: getWorkspaceWorkflowsOpenApi
      parameters:
      - name: workspaceId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: OpenAPI document describing this workspace's published workflows
      tags:
      - Public
      x-feature: workspace
components:
  schemas:
    PublicWorkflowSummaryDto:
      type: object
      properties:
        slug:
          type: string
          description: Slug used in the run URL
        workflowName:
          type: string
        version:
          type: string
        displayName:
          type: string
        description:
          type: string
        inputSchema:
          type: object
          description: JSON Schema of the request body for the run endpoint
          additionalProperties: true
        outputSchema:
          type: object
          description: JSON Schema of the workflow output (sync mode response)
          additionalProperties: true
      required:
      - slug
      - workflowName
      - version
    RunPublicWorkflowResponseDto:
      type: object
      properties:
        runId:
          type: string
        status:
          type: string
          description: Run status. `completed`/`failed`/`cancelled` are terminal; anything else means the run is still executing (poll the status endpoint).
        output:
          type: object
          description: Workflow output (present when completed in sync mode)
          additionalProperties: true
        error:
          type: string
          description: Error message for failed runs
        pollUrl:
          type: string
          description: Poll URL for async runs
      required:
      - runId
      - status
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key