SoftSync AI API Keys API

openapi: 3.2.0
info:
  title: Softsync API Keys 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: API Keys
paths:
  /api-keys:
    post:
      operationId: createApiKey
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiKeyResponseDto'
      summary: Create a new API Key
      tags:
      - API Keys
      x-feature: api
    get:
      operationId: listKeys
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiKeyResponseDto'
      summary: List API Keys for workspace
      tags:
      - API Keys
      x-feature: api
  /api-keys/{id}:
    delete:
      operationId: deleteKey
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Revoke and delete an API Key
      tags:
      - API Keys
      x-feature: api
  /api-keys/info:
    get:
      operationId: getInfo
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyResponseDto'
      summary: Retrieve the API Basic Information like the user and the workspace
      tags:
      - API Keys
      x-feature: api
  /api-keys/oauth/authorize:
    post:
      operationId: authorize
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthAuthorizeDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthAuthorizeResponseDto'
      summary: OAuth 2.1 Authorize (Generates Code)
      tags:
      - API Keys
      x-feature: api
  /api-keys/oauth/token:
    post:
      operationId: exchange
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthExchangeDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthTokenResponseDto'
      summary: OAuth 2.1 Token Exchange
      tags:
      - API Keys
      x-feature: api
components:
  schemas:
    OAuthAuthorizeDto:
      type: object
      properties:
        clientId:
          type: string
        redirectUri:
          type: string
        state:
          type: string
        responseType:
          type: string
        codeChallenge:
          type: string
          description: PKCE S256 code challenge
        codeChallengeMethod:
          type: string
          description: PKCE code challenge method (S256)
        resource:
          type: string
          description: RFC 8707 resource indicator
        workspaceIds:
          description: More organizations the connection may act in, besides the current one (the default).
          type: array
          items:
            type: string
        allWorkspaces:
          type: boolean
          description: Every organization you are a member of, including ones created later. MCP connections only.
      required:
      - clientId
      - redirectUri
    OAuthAuthorizeResponseDto:
      type: object
      properties:
        redirectUri:
          type: string
      required:
      - redirectUri
    PartnerDto:
      type: object
      properties:
        name:
          type: string
        website:
          type: string
        imageUrl:
          type: string
        provider:
          allOf:
          - $ref: '#/components/schemas/WorkspaceProvider'
      required:
      - name
      - website
      - imageUrl
    WorkspaceProvider:
      type: string
      enum:
      - softsync
      - doneai
      - analystx
      description: Provider configured in the requesting client. Defaults to the server default for older clients.
    OAuthExchangeDto:
      type: object
      properties:
        clientId:
          type: string
        clientSecret:
          type: string
        code:
          type: string
        codeVerifier:
          type: string
          description: PKCE code verifier
        redirectUri:
          type: string
          description: Must match the redirect_uri used at authorization
        resource:
          type: string
          description: RFC 8707 resource indicator
      required:
      - clientId
      - clientSecret
      - code
    APIInfoDto:
      type: object
      properties:
        userId:
          type: string
          description: The ID of the user
        email:
          type: string
          description: The email of the user
        firstName:
          type: string
          description: User's first name
        lastName:
          type: string
          description: User's last name
        workspaceId:
          type: string
          description: The ID of the workspace
        workspaceName:
          type: string
          description: The name of the workspace
      required:
      - userId
      - email
      - workspaceId
      - workspaceName
    CreateApiKeyResponseDto:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        keyPrefix:
          type: string
        createdAt:
          format: date-time
          type: string
        lastUsedAt:
          format: date-time
          type: string
        partner:
          $ref: '#/components/schemas/PartnerDto'
        info:
          $ref: '#/components/schemas/APIInfoDto'
        rawKey:
          type: string
      required:
      - id
      - label
      - keyPrefix
      - createdAt
      - lastUsedAt
      - rawKey
    OAuthTokenResponseDto:
      type: object
      properties:
        accessToken:
          type: string
        tokenType:
          type: string
          example: Bearer
        expiresIn:
          type: number
          description: Token lifetime in seconds
          example: 28800
        scope:
          type: string
          example: full
        refreshToken:
          type: string
          description: Long-lived token for obtaining a new access token via grant_type=refresh_token, without sending the user through consent again.
      required:
      - accessToken
      - tokenType
      - expiresIn
      - scope
    ApiKeyResponseDto:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        keyPrefix:
          type: string
        createdAt:
          format: date-time
          type: string
        lastUsedAt:
          format: date-time
          type: string
        partner:
          $ref: '#/components/schemas/PartnerDto'
        info:
          $ref: '#/components/schemas/APIInfoDto'
      required:
      - id
      - label
      - keyPrefix
      - createdAt
      - lastUsedAt
    CreateApiKeyDto:
      type: object
      properties:
        label:
          type: string
        partnerId:
          type: string
      required:
      - label
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key