API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

ChatKit

ModelsExpand Collapse

ChatKitWorkflow { id, state_variables, tracing, version }

Workflow metadata and state returned for the session.

ChatKitSessions

Cancel a ChatKit session

client.beta.chatkit.sessions.cancel(stringsessionID, RequestOptionsoptions?): ChatSession { id, chatkit_configuration, client_secret, 7 more }

POST/chatkit/sessions/{session_id}/cancel

Create a ChatKit session

client.beta.chatkit.sessions.create(SessionCreateParams { user, workflow, chatkit_configuration, 2 more } body, RequestOptionsoptions?): ChatSession { id, chatkit_configuration, client_secret, 7 more }

POST/chatkit/sessions

ChatKitThreads

Delete a ChatKit thread

client.beta.chatkit.threads.delete(stringthreadID, RequestOptionsoptions?): ThreadDeleteResponse { id, deleted, object }

DELETE/chatkit/threads/{thread_id}

List ChatKit threads

client.beta.chatkit.threads.list(ThreadListParams { after, before, limit, 2 more } query?, RequestOptionsoptions?): ConversationCursorPage<ChatKitThread { id, created_at, object, 3 more } >

GET/chatkit/threads

List ChatKit thread items

client.beta.chatkit.threads.listItems(stringthreadID, ThreadListItemsParams { after, before, limit, order } query?, RequestOptionsoptions?): ConversationCursorPage<ChatKitThreadUserMessageItem { id, attachments, content, 5 more } | ChatKitThreadAssistantMessageItem { id, content, created_at, 3 more } | ChatKitWidgetItem { id, created_at, object, 3 more } | 3 more>

GET/chatkit/threads/{thread_id}/items

Retrieve a ChatKit thread

client.beta.chatkit.threads.retrieve(stringthreadID, RequestOptionsoptions?): ChatKitThread { id, created_at, object, 3 more }

GET/chatkit/threads/{thread_id}

ModelsExpand Collapse

ChatSession { id, chatkit_configuration, client_secret, 7 more }

Represents a ChatKit session and its resolved configuration.

ChatSessionAutomaticThreadTitling { enabled }

Automatic thread title preferences for the session.

ChatSessionChatKitConfiguration { automatic_thread_titling, file_upload, history }

ChatKit configuration for the session.

ChatSessionChatKitConfigurationParam { automatic_thread_titling, file_upload, history }

Optional per-session configuration settings for ChatKit behavior.

ChatSessionExpiresAfterParam { anchor, seconds }

Controls when the session expires relative to an anchor timestamp.

ChatSessionFileUpload { enabled, max_file_size, max_files }

Upload permissions and limits applied to the session.

ChatSessionHistory { enabled, recent_threads }

History retention preferences returned for the session.

ChatSessionRateLimits { max_requests_per_1_minute }

Active per-minute request limit for the session.

ChatSessionRateLimitsParam { max_requests_per_1_minute }

Controls request rate limits for the session.

ChatSessionStatus = "active" | "expired" | "cancelled"

ChatSessionWorkflowParam { id, state_variables, tracing, version }

Workflow reference and overrides applied to the chat session.

ChatKitAttachment { id, mime_type, name, 2 more }

Attachment metadata included on thread items.

ChatKitResponseOutputText { annotations, text, type }

Assistant response text accompanied by optional annotations.

ChatKitThread { id, created_at, object, 3 more }

Represents a ChatKit thread and its current status.

ChatKitThreadAssistantMessageItem { id, content, created_at, 3 more }

Assistant-authored message within a thread.

ChatKitThreadItemList { data, first_id, has_more, 2 more }

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

ChatKitThreadUserMessageItem { id, attachments, content, 5 more }

User-authored messages within a thread.

ChatKitWidgetItem { id, created_at, object, 3 more }

Thread item that renders a widget payload.

ThreadDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a thread.