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

ChatKit

ModelsExpand Collapse
chatkit_workflow: object { id, state_variables, tracing, version }

Workflow metadata and state returned for the session.

ChatKitSessions

Cancel a ChatKit session
$ openai beta:chatkit:sessions cancel
POST/chatkit/sessions/{session_id}/cancel
Create a ChatKit session
$ openai beta:chatkit:sessions create
POST/chatkit/sessions

ChatKitThreads

Delete a ChatKit thread
$ openai beta:chatkit:threads delete
DELETE/chatkit/threads/{thread_id}
List ChatKit threads
$ openai beta:chatkit:threads list
GET/chatkit/threads
List ChatKit thread items
$ openai beta:chatkit:threads list-items
GET/chatkit/threads/{thread_id}/items
Retrieve a ChatKit thread
$ openai beta:chatkit:threads retrieve
GET/chatkit/threads/{thread_id}
ModelsExpand Collapse
chat_session: object { id, chatkit_configuration, client_secret, 7 more }

Represents a ChatKit session and its resolved configuration.

chat_session_automatic_thread_titling: object { enabled }

Automatic thread title preferences for the session.

chat_session_chatkit_configuration: object { automatic_thread_titling, file_upload, history }

ChatKit configuration for the session.

chat_session_chatkit_configuration_param: object { automatic_thread_titling, file_upload, history }

Optional per-session configuration settings for ChatKit behavior.

chat_session_expires_after_param: object { anchor, seconds }

Controls when the session expires relative to an anchor timestamp.

chat_session_file_upload: object { enabled, max_file_size, max_files }

Upload permissions and limits applied to the session.

chat_session_history: object { enabled, recent_threads }

History retention preferences returned for the session.

chat_session_rate_limits: object { max_requests_per_1_minute }

Active per-minute request limit for the session.

chat_session_rate_limits_param: object { max_requests_per_1_minute }

Controls request rate limits for the session.

chat_session_status: "active" or "expired" or "cancelled"
chat_session_workflow_param: object { id, state_variables, tracing, version }

Workflow reference and overrides applied to the chat session.

chatkit_attachment: object { id, mime_type, name, 2 more }

Attachment metadata included on thread items.

chatkit_response_output_text: object { annotations, text, type }

Assistant response text accompanied by optional annotations.

chatkit_thread: object { id, created_at, object, 3 more }

Represents a ChatKit thread and its current status.

chatkit_thread_assistant_message_item: object { id, content, created_at, 3 more }

Assistant-authored message within a thread.

chatkit_thread_item_list: object { data, first_id, has_more, 2 more }

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

chatkit_thread_user_message_item: object { id, attachments, content, 5 more }

User-authored messages within a thread.

chatkit_widget_item: object { id, created_at, object, 3 more }

Thread item that renders a widget payload.