communicate-so · Schema

ChatResponse

Artificial IntelligenceCustomer ServiceChatbotsSoftware-as-a-ServiceAutomation

Properties

Name Type Description
conversationId string
ticketNumber integernull
messageId string
userMessageId string
answer string
citations array
mode string
actionName string Present when a workspace action produced the final answer.
followUps array Optional suggested next questions returned with the answer.
View JSON Schema on GitHub

JSON Schema

communicate-so-chat-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/communicate-so/json-schema/communicate-so-chat-response-schema.json",
  "title": "ChatResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/communicate-so-chat-api-openapi.yml#/components/schemas/ChatResponse",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "conversationId",
    "messageId",
    "userMessageId",
    "answer",
    "citations",
    "mode"
  ],
  "properties": {
    "conversationId": {
      "type": "string"
    },
    "ticketNumber": {
      "type": [
        "integer",
        "null"
      ]
    },
    "messageId": {
      "type": "string"
    },
    "userMessageId": {
      "type": "string"
    },
    "answer": {
      "type": "string"
    },
    "citations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Citation"
      }
    },
    "mode": {
      "type": "string",
      "enum": [
        "ai",
        "human"
      ]
    },
    "actionName": {
      "type": "string",
      "description": "Present when a workspace action produced the final answer."
    },
    "followUps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 3,
      "description": "Optional suggested next questions returned with the answer."
    }
  },
  "$defs": {
    "Citation": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "sourceId",
        "title",
        "snippet",
        "url"
      ],
      "properties": {
        "sourceId": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "snippet": {
          "type": "string"
        },
        "url": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}

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-chat-response"
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.