openai · OpenAI Platform Docs
Advanced integrations with ChatKit
A guide for self-hosting ChatKit on private infrastructure by implementing a custom server class, exposing HTTP endpoints, and defining data and file storage contracts.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Advanced integrations with ChatKit
A guide for self-hosting ChatKit on private infrastructure by implementing a custom server class, exposing HTTP endpoints, and defining data and file storage contracts.
When To Use
Use when you need to deploy ChatKit on-premises or on your own infrastructure to manage custom authentication, data residency, or bespoke agent orchestration.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/advanced-integrations-with-chatkit-workflow-guide.md | A guide detailing how to set up and implement a custom ChatKit server on private infrastructure for advanced control over authentication and data residency. | Questions about a guide detailing how to set up and implement a custom ChatKit server on private infrastructure for advanced control... |
examples/advanced-integrations-with-chatkit-chatkit-installation.bash | The bash command to install the openai-chatkit package using pip. | Exact payloads, commands, or snippets shown in The bash command to install the openai-chatkit package using pip. |
examples/advanced-integrations-with-chatkit-chatkit-server-custom-implementation.python | A Python implementation of a custom ChatKitServer class demonstrating advanced integration with datastores and agent contexts. | Exact payloads, commands, or snippets shown in A Python implementation of a custom ChatKitServer class demonstrating advanced integration with datastores and agent... |
examples/advanced-integrations-with-chatkit-chatkit-fastapi-python-server-impleme.python | A Python implementation of a FastAPI server using ChatKit with SQLite and DiskFileStore for handling streaming responses. | Exact payloads, commands, or snippets shown in A Python implementation of a FastAPI server using ChatKit with SQLite and DiskFileStore for handling streaming respon... |
examples/advanced-integrations-with-chatkit-chatkit-advanced-integration-python-f.python | A Python code example demonstrating the use of the @function_tool decorator to define tool calls within a ChatKit integration. | Exact payloads, commands, or snippets shown in A Python code example demonstrating the use of the @functiontool decorator to define tool calls within a ChatKit inte... |
examples/advanced-integrations-with-chatkit-chatkit-advanced-integration-python-a.python | A Python implementation of an asynchronous respond function using ChatKit to stream widget events and card components. | Exact payloads, commands, or snippets shown in A Python implementation of an asynchronous respond function using ChatKit to stream widget events and card components. |
examples/advanced-integrations-with-chatkit-chatkit-custom-events-typescript-inte.ts | A TypeScript definition of the custom event types used for advanced ChatKit integrations. | Exact payloads, commands, or snippets shown in A TypeScript definition of the custom event types used for advanced ChatKit integrations. |
What This Skill Covers
- When you need full control—custom authentication, data residency, on‑prem deployment, or bespoke agent orchestration—you can run ChatKit on your own infrastr...
- Main sections:
Run ChatKit on your own infrastructure,Set up your ChatKit server,1. Install the server package,2. Implement a server class,3. Expose the endpoint.
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/custom-chatkit.md