Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference
API Reference
Beta

ChatKit

ModelsExpand Collapse
type ChatKitWorkflow struct{…}

Workflow metadata and state returned for the session.

ChatKitSessions

Cancel a ChatKit session
client.Beta.ChatKit.Sessions.Cancel(ctx, sessionID) (*ChatSession, error)
POST/chatkit/sessions/{session_id}/cancel
Create a ChatKit session
client.Beta.ChatKit.Sessions.New(ctx, body) (*ChatSession, error)
POST/chatkit/sessions

ChatKitThreads

Delete a ChatKit thread
client.Beta.ChatKit.Threads.Delete(ctx, threadID) (*BetaChatKitThreadDeleteResponse, error)
DELETE/chatkit/threads/{thread_id}
List ChatKit threads
client.Beta.ChatKit.Threads.List(ctx, query) (*ConversationCursorPage[ChatKitThread], error)
GET/chatkit/threads
List ChatKit thread items
client.Beta.ChatKit.Threads.ListItems(ctx, threadID, query) (*ConversationCursorPage[ChatKitThreadItemListDataUnion], error)
GET/chatkit/threads/{thread_id}/items
Retrieve a ChatKit thread
client.Beta.ChatKit.Threads.Get(ctx, threadID) (*ChatKitThread, error)
GET/chatkit/threads/{thread_id}
ModelsExpand Collapse
type ChatSession struct{…}

Represents a ChatKit session and its resolved configuration.

type ChatSessionAutomaticThreadTitling struct{…}

Automatic thread title preferences for the session.

type ChatSessionChatKitConfiguration struct{…}

ChatKit configuration for the session.

type ChatSessionChatKitConfigurationParamResp struct{…}

Optional per-session configuration settings for ChatKit behavior.

type ChatSessionExpiresAfterParamResp struct{…}

Controls when the session expires relative to an anchor timestamp.

type ChatSessionFileUpload struct{…}

Upload permissions and limits applied to the session.

type ChatSessionHistory struct{…}

History retention preferences returned for the session.

type ChatSessionRateLimits struct{…}

Active per-minute request limit for the session.

type ChatSessionRateLimitsParamResp struct{…}

Controls request rate limits for the session.

type ChatSessionStatus string
type ChatSessionWorkflowParamResp struct{…}

Workflow reference and overrides applied to the chat session.

type ChatKitAttachment struct{…}

Attachment metadata included on thread items.

type ChatKitResponseOutputText struct{…}

Assistant response text accompanied by optional annotations.

type ChatKitThread struct{…}

Represents a ChatKit thread and its current status.

type ChatKitThreadAssistantMessageItem struct{…}

Assistant-authored message within a thread.

type ChatKitThreadItemList struct{…}

A paginated list of thread items rendered for the ChatKit API.

type ChatKitThreadUserMessageItem struct{…}

User-authored messages within a thread.

type ChatKitWidgetItem struct{…}

Thread item that renders a widget payload.