openai · OpenAI Platform Docs
Actions in ChatKit | OpenAI API
Explains how to implement and configure Actions within ChatKit to enable external tool integration and functional capabilities for chat interfaces.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Actions in ChatKit | OpenAI API
Explains how to implement and configure Actions within ChatKit to enable external tool integration and functional capabilities for chat interfaces.
When To Use
Use when you need to integrate external APIs or custom tools into a ChatKit-powered interface to allow the model to perform real-world tasks.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/actions-in-chatkit-openai-api-workflow-guide.md | A guide explaining how to trigger streaming responses and side-effects using actions within the ChatKit SDK. | Questions about a guide explaining how to trigger streaming responses and side-effects using actions within the ChatKit SDK. |
examples/actions-in-chatkit-openai-api-chatkit-actions-button-config.text | A text example demonstrating the configuration of a Button component with an onClickAction and payload for ChatKit actions. | Exact payloads, commands, or snippets shown in A text example demonstrating the configuration of a Button component with an onClickAction and payload for ChatKit ac... |
examples/actions-in-chatkit-openai-api-chatkit-actions-sendaction-javascript.text | A JavaScript code snippet demonstrating how to use the chatKit.sendAction method to dispatch an action with a payload. | Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to use the chatKit.sendAction method to dispatch an action with a payload. |
examples/actions-in-chatkit-openai-api-chatkit-actions-python-server-implementati.text | A Python implementation of a ChatKitServer class demonstrating how to handle asynchronous actions within a ChatKit environment. | Exact payloads, commands, or snippets shown in A Python implementation of a ChatKitServer class demonstrating how to handle asynchronous actions within a ChatKit en... |
examples/actions-in-chatkit-openai-api-chatkit-actions-button-config-2.text | A text representation of a Button component configuration using ActionConfig with a client-side handler and payload. | Exact payloads, commands, or snippets shown in A text representation of a Button component configuration using ActionConfig with a client-side handler and payload. |
examples/actions-in-chatkit-openai-api-chatkit-actions-javascript-handlewidgetact.text | A JavaScript code example demonstrating how to handle widget actions and send actions back to the server using the ChatKit API. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to handle widget actions and send actions back to the server using the Ch... |
examples/actions-in-chatkit-openai-api-chatkit-actions-python-pydantic-payload.text | A Python code snippet demonstrating how to define ChatKit action payloads using Pydantic models and discriminated unions. | Exact payloads, commands, or snippets shown in A Python code snippet demonstrating how to define ChatKit action payloads using Pydantic models and discriminated uni... |
examples/actions-in-chatkit-openai-api-chatkit-actions-form-onsubmit-action-confi.text | A code snippet demonstrating the implementation of an onSubmitAction using ActionConfig within a ChatKit Form component. | Exact payloads, commands, or snippets shown in A code snippet demonstrating the implementation of an onSubmitAction using ActionConfig within a ChatKit Form component. |
examples/actions-in-chatkit-openai-api-chatkit-actions-button-config-3.text | A text representation of a ChatKit Button component configured with a long-running action type and container loading behavior. | Exact payloads, commands, or snippets shown in A text representation of a ChatKit Button component configured with a long-running action type and container loading... |
What This Skill Covers
- Actions are a way for the ChatKit SDK frontend to trigger a streaming response without the user submitting a message. They can also be used to trigger side-e...
- Main sections:
Triggering actions,In response to user interaction with widgets,Handling actions,On the server,Client.
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-actions