communicate-so Discovery API

openapi: 3.2.0
info:
  title: Communicate So Discovery API
  version: 0.1.5
  description: 'Operations tagged Discovery across 2 of this provider''s published API definitions: communicate-so-openapi.json, communicate-so-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.communicate.so/api/v1
  description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Discovery
paths:
  /capabilities:
    get:
      operationId: listCapabilities
      summary: List registered contracts and surface availability
      description: Reports registered shared contracts, schemas and adapter availability. Complete coverage means every account route is an operation or a documented exclusion; unavailable adapters are explicitly marked unsupported.
      tags:
      - Discovery
      security: []
      responses:
        '200':
          description: Registered operation contracts and surface availability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilityDocument'
    servers:
    - url: https://app.communicate.so/api/v1
      description: Canonical external base URL served through the Next.js /api/v1 rewrite.
components:
  schemas:
    CapabilityDocument:
      type: object
      properties:
        schemaVersion:
          type: string
          const: 1.0.0
        coverage:
          type: string
          enum:
          - partial
          - complete
        operations:
          type: array
          items:
            type: object
            properties:
              operationId:
                type: string
              summary:
                type: string
              credentialKind:
                type: string
                enum:
                - public
                - password-proof
                - workspace-key-or-oauth-token
                - verified-session
                - verified-session-with-fresh-proof
                - account-key-or-session
              scopes:
                type: array
                items:
                  type: string
              readOnly:
                type: boolean
              api:
                type: object
                properties:
                  supported:
                    type: boolean
                  method:
                    type: string
                    enum:
                    - GET
                    - POST
                    - PUT
                    - PATCH
                    - DELETE
                  path:
                    type: string
                  successStatus:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  successStatuses:
                    type: array
                    items:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                  requestBodyProperty:
                    type: string
                  requestMediaType:
                    type: string
                    enum:
                    - application/json
                    - multipart/form-data
                required:
                - supported
                - method
                - path
                additionalProperties: false
              cli:
                type: object
                properties:
                  supported:
                    type: boolean
                  command:
                    type: string
                required:
                - supported
                - command
                additionalProperties: false
              mcp:
                type: object
                properties:
                  supported:
                    type: boolean
                  tool:
                    type: string
                required:
                - supported
                - tool
                additionalProperties: false
              inputSchema:
                type: object
                propertyNames:
                  type: string
                additionalProperties: {}
              outputSchema:
                type: object
                propertyNames:
                  type: string
                additionalProperties: {}
            required:
            - operationId
            - summary
            - credentialKind
            - scopes
            - readOnly
            - api
            - cli
            - mcp
            - inputSchema
            - outputSchema
            additionalProperties: false
      required:
      - schemaVersion
      - coverage
      - operations
      additionalProperties: false
  securitySchemes:
    accountSession:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: Signed Better Auth session cookie for an HTTPS application origin. Credential management additionally requires verified email and fresh password proof on writes.
    localAccountSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Signed session cookie used when the configured application auth origin is HTTP, such as local development.
    accountBearer:
      type: http
      scheme: bearer
      bearerFormat: Account credential
      description: Opaque user-bound `ca_` account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace `ck_` key or OAuth access token.
    clientCredentialsBasic:
      type: http
      scheme: basic
      description: Use the API key ID as the username and the one-time `ck_` API key token as the password.
    oauth2:
      type: oauth2
      description: OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.
      flows:
        clientCredentials:
          tokenUrl: https://app.communicate.so/api/v1/oauth/token
          scopes:
            agents:read: List agents in the authenticated workspace.
            chat:write: Create chat turns with an agent in the authenticated workspace.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Workspace API key token with the `ck_` prefix.
x-refined-from:
- communicate-so-openapi.json
- communicate-so-openapi.json