IBM API Connect · Schema

PortalChatbot

API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM

Properties

Name Type Description
type string Request/response type. Use 'user-message' to send a message. Use 'user-plan' to execute a plan (toolcalls required). Response types include 'agent-plan' and 'agent-response'.
message string The user's message to send to the AI agent (used with type 'user-message')
agent_message string The AI agent's response message
plan_title stringnull Title of the plan from the AI agent
plan_description stringnull Description of the plan from the AI agent
View JSON Schema on GitHub

JSON Schema

ibm-api-connect-portal-chatbot-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-portal-chatbot-schema.json",
  "title": "PortalChatbot",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-portal-api-openapi.yml#/components/schemas/PortalChatbot",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "type": {
      "type": "string",
      "description": "Request/response type. Use 'user-message' to send a message. Use 'user-plan' to execute a plan (toolcalls required). Response types include 'agent-plan' and 'agent-response'."
    },
    "message": {
      "type": "string",
      "description": "The user's message to send to the AI agent (used with type 'user-message')",
      "maxLength": 4000
    },
    "agent_message": {
      "type": "string",
      "description": "The AI agent's response message",
      "items": {
        "type": "object"
      }
    },
    "plan_title": {
      "type": [
        "string",
        "null"
      ],
      "description": "Title of the plan from the AI agent"
    },
    "plan_description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description of the plan from the AI agent"
    }
  }
}

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/ibm-api-connect-portal-chatbot"
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.