communicate-so · Schema

CapabilityDocument

Artificial IntelligenceCustomer ServiceChatbotsSoftware-as-a-ServiceAutomation

Properties

Name Type Description
schemaVersion string
coverage string
operations array
View JSON Schema on GitHub

JSON Schema

communicate-so-capability-document-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/communicate-so/json-schema/communicate-so-capability-document-schema.json",
  "title": "CapabilityDocument",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/communicate-so-discovery-api-openapi.yml#/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
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/communicate-so-capability-document"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.