> ## Documentation Index
> Fetch the complete documentation index at: https://developer.communicate.so/llms.txt
> Use this file to discover all available pages before exploring further.

# List registered contracts and surface availability

> Reports registered shared contracts, schemas and adapter availability. Partial coverage does not advertise full headless support; unavailable adapters are explicitly marked unsupported.



## OpenAPI

````yaml https://app.communicate.so/api/v1/openapi/mintlify.json get /capabilities
openapi: 3.1.0
info:
  title: Communicate Public REST API
  version: 1.1.0
  summary: >-
    Scoped agent chat, account credential lifecycle and workspace bootstrap
    operations.
  description: >-
    Canonical external schema for implemented REST operations. Account
    credentials and application sessions authorize the documented account and
    workspace operations separately from workspace keys. Exchange a workspace
    API-key client ID and secret for a short-lived OAuth access token, or use
    the `ck_` key directly for backward compatibility. `requestId` is optional
    but, when supplied, becomes the idempotency key for retries of the same chat
    input.
servers:
  - url: https://app.communicate.so/api/v1
    description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
  - oauth2: []
  - bearerAuth: []
paths:
  /capabilities:
    get:
      tags:
        - Discovery
      summary: List registered contracts and surface availability
      description: >-
        Reports registered shared contracts, schemas and adapter availability.
        Partial coverage does not advertise full headless support; unavailable
        adapters are explicitly marked unsupported.
      operationId: listCapabilities
      responses:
        '200':
          description: Registered operation contracts and surface availability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilityDocument'
      security: []
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
                  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:
    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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.