AsyncAPI channel · Jupyter Notebook · Jupyter Kernel Messaging Protocol

/api/kernels/{kernel_id}/channels

Provider: Jupyter Notebook AsyncAPI: v2.6.0 Spec: Jupyter Kernel Messaging Protocol Operations: 2 Messages: 30

Channel address

/api/kernels/{kernel_id}/channels

Parameters

Operations

publish
sendKernelMessage
Send a message to the kernel
receiveKernelMessage
Receive a message from the kernel

Messages

execute_request
Request to execute code in the kernel.
Content-Type: application/json
inspect_request
Request to inspect an object at cursor position.
Content-Type: application/json
complete_request
Request code completion suggestions.
Content-Type: application/json
history_request
Request execution history from the kernel.
Content-Type: application/json
is_complete_request
Check if code is complete and ready to execute.
Content-Type: application/json
kernel_info_request
Request information about the kernel.
Content-Type: application/json
shutdown_request
Request the kernel to shut down.
Content-Type: application/json
interrupt_request
Request to interrupt the kernel.
Content-Type: application/json
input_reply
Frontend sends user input to the kernel.
Content-Type: application/json
comm_open
Open a comm channel for custom messaging (e.g., widgets).
Content-Type: application/json
comm_msg
Send a message on an open comm channel.
Content-Type: application/json
comm_close
Close a comm channel.
Content-Type: application/json
execute_reply
Reply to an execute request with status and execution count.
Content-Type: application/json
inspect_reply
Reply with object inspection results.
Content-Type: application/json
complete_reply
Reply with code completion matches.
Content-Type: application/json
history_reply
Reply with execution history entries.
Content-Type: application/json
is_complete_reply
Reply indicating whether code is complete.
Content-Type: application/json
kernel_info_reply
Reply with kernel implementation and language information.
Content-Type: application/json
shutdown_reply
Reply confirming kernel shutdown.
Content-Type: application/json
execute_input
Broadcast of code being executed (for all connected clients).
Content-Type: application/json
execute_result
Result of an execution, equivalent to the Out[] prompt in IPython. Contains rich display data.
Content-Type: application/json
stream
Standard output or standard error stream data from code execution.
Content-Type: application/json
display_data
Rich display data output from code execution, supporting multiple MIME types.
Content-Type: application/json
update_display_data
Update a previous display_data output.
Content-Type: application/json
error
Error output from failed code execution.
Content-Type: application/json
status
Kernel execution state broadcast. Published on every state change (busy, idle, starting).
Content-Type: application/json
clear_output
Request to clear output area in the frontend.
Content-Type: application/json
input_request
Kernel requests input from the frontend (e.g., for Python's input() function).
Content-Type: application/json
debug_reply
Reply to a debug request.
Content-Type: application/json
debug_event
Debug event broadcast from the kernel.
Content-Type: application/json

About AsyncAPI

The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.

Browse every event-driven channel on the APIs.io network or compare with the broader Naftiko capability, Agent Skill, and MCP server surfaces of the same providers.