API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

ChatKit

ModelsExpand Collapse

class ChatKitWorkflow: …

Workflow metadata and state returned for the session.

ChatKitSessions

Cancel a ChatKit session

beta.chatkit.sessions.cancel(strsession_id) -> ChatSession

POST/chatkit/sessions/{session_id}/cancel

Create a ChatKit session

beta.chatkit.sessions.create(SessionCreateParams**kwargs) -> ChatSession

POST/chatkit/sessions

ChatKitThreads

Delete a ChatKit thread

beta.chatkit.threads.delete(strthread_id) -> ThreadDeleteResponse

DELETE/chatkit/threads/{thread_id}

List ChatKit threads

beta.chatkit.threads.list(ThreadListParams**kwargs) -> SyncConversationCursorPage[ChatKitThread]

GET/chatkit/threads

List ChatKit thread items

beta.chatkit.threads.list_items(strthread_id, ThreadListItemsParams**kwargs) -> SyncConversationCursorPage[Data]

GET/chatkit/threads/{thread_id}/items

Retrieve a ChatKit thread

beta.chatkit.threads.retrieve(strthread_id) -> ChatKitThread

GET/chatkit/threads/{thread_id}

ModelsExpand Collapse

class ChatSession: …

Represents a ChatKit session and its resolved configuration.

class ChatSessionAutomaticThreadTitling: …

Automatic thread title preferences for the session.

class ChatSessionChatKitConfiguration: …

ChatKit configuration for the session.

class ChatSessionChatKitConfigurationParam: …

Optional per-session configuration settings for ChatKit behavior.

class ChatSessionExpiresAfterParam: …

Controls when the session expires relative to an anchor timestamp.

class ChatSessionFileUpload: …

Upload permissions and limits applied to the session.

class ChatSessionHistory: …

History retention preferences returned for the session.

class ChatSessionRateLimits: …

Active per-minute request limit for the session.

class ChatSessionRateLimitsParam: …

Controls request rate limits for the session.

Literal["active", "expired", "cancelled"]

class ChatSessionWorkflowParam: …

Workflow reference and overrides applied to the chat session.

class ChatKitAttachment: …

Attachment metadata included on thread items.

class ChatKitResponseOutputText: …

Assistant response text accompanied by optional annotations.

class ChatKitThread: …

Represents a ChatKit thread and its current status.

class ChatKitThreadAssistantMessageItem: …

Assistant-authored message within a thread.

class ChatKitThreadItemList: …

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

class ChatKitThreadUserMessageItem: …

User-authored messages within a thread.

class ChatKitWidgetItem: …

Thread item that renders a widget payload.

class ThreadDeleteResponse: …

Confirmation payload returned after deleting a thread.