openai · OpenAI Platform Docs

ChatKit widgets

Teaches how to design, customize, and implement interactive ChatKit widgets by using the Widget Builder, hosting assets on a backend, and handling user-triggered action payloads via server-side callbacks.

Import to Prompt Buddy

Derived skill

Files assembled from official documentation

Viewing SKILL.md

ChatKit widgets

When To Use

Use when you need to implement custom UI components in ChatKit, manage asset hosting for widgets, or process interactive user actions on your backend.

Reference Files

File	Contains	Use For
`SKILL.md`	Entry point: scope, routing table, and workflow.	Start here.
`docs/chatkit-widgets-workflow-guide.md`	A guide explaining how to design, upload assets, and handle actions for ChatKit widgets.	Questions about a guide explaining how to design, upload assets, and handle actions for ChatKit widgets.
`examples/chatkit-widgets-typescript-onaction-handler.ts`	A TypeScript code example demonstrating how to implement the async onAction handler within the ChatKit widgets configuration.	Exact payloads, commands, or snippets shown in A TypeScript code example demonstrating how to implement the async onAction handler within the ChatKit widgets config...

What This Skill Covers

Widgets are the containers and components that come with ChatKit. You can use prebuilt widgets, modify templates, or design your own to fully customize ChatK...
Main sections: Design widgets quickly, Upload assets, Handle actions on your server, Reference, Containers (WidgetRoot).

Workflow

Open the most relevant file under docs/ for the exact documented workflow and wording.
Open schemas/ files for exact structured contracts.
Open examples/ files for concrete requests, commands, snippets, and manifests.
Do not add behavior or configuration that is not present in the attached source files.

Canonical source: https://developers.openai.com/api/docs/guides/chatkit-widgets.md