Skip to content

Select theme

Overview
Guides
API Reference
- @openai/chatkit
- @openai/chatkit-react
  - Namespaces
    
    Widgets
    
    type-aliases
    
    ActionConfig
    Alignment
    Badge
    BaseTextProps
    BasicRoot
    BlockProps
    Border
    Borders
    Box
    BoxBaseProps
    Button
    Caption
    CaptionSize
    Card
    CardAction
    Checkbox
    Col
    ControlSize
    ControlVariant
    DatePicker
    Divider
    Form
    Icon
    IconSize
    Image
    Input
    Justification
    Label
    ListView
    ListViewItem
    Markdown
    RadioGroup
    RadiusValue
    Row
    Select
    Spacer
    Spacing
    TextAlign
    Textarea
    TextComponent
    TextSize
    ThemeColor
    Title
    TitleSize
    Transition
    WidgetComponent
    WidgetIcon
    WidgetRoot
    WidgetStatus
  - Interfaces
    
    OpenAIChatKit
  - Type Aliases
    
    AccentColor
    Attachment
    ChatKitControl
    ChatKitEvents
    ChatKitIcon
    ChatKitOptions
    ColorOption
    ColorScheme
    ComposerOption
    CustomApiConfig
    DisclaimerOption
    EntitiesOption
    Entity
    EventHandler
    FileUploadStrategy
    FontObject
    GrayscaleOptions
    HeaderIcon
    HeaderOption
    HistoryOption
    HostedApiConfig
    ModelOption
    StartScreenOption
    StartScreenPrompt
    SupportedLocale
    SurfaceColors
    ThemeOption
    ThreadItemActionsOption
    ToolOption
    TranslatedLocale
    TypographyOption
    UseChatKitOptions
    UseChatKitReturn
    WidgetsOption
  - Variables
    
    ChatKit
  - Functions
    
    useChatKit
Custom Backends
- Python SDK
Examples
- Starter App
- Advanced Samples

Select theme

On this page

Overview
Parameters
Returns

On this page

Overview
Parameters
Returns

useChatKit

function useChatKit(options: UseChatKitOptions): UseChatKitReturn;

Parameters

Section titled “Parameters”

Parameter	Type
`options`	`UseChatKitOptions`

Returns

Section titled “Returns”

UseChatKitReturn