How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenAI

OpenAI Chatkit API

The Chatkit API from OpenAI — 5 operation(s) for chatkit.

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenAI Chatkit API is one of 62 APIs that OpenAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include ChatKit. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 2.3.0.

Requests are made against a single base URL, https://api.openai.com/v1.

6 operations 5 paths 47 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.3.0
Base URL
https://api.openai.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
OpenAI Support
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

OpenAI Chatkit API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). It accepts HTTP bearer tokens (AdminApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Chatkit 6
POST
/chatkit/sessions/{session_id}/cancel
Cancel a ChatKit session
CancelChatSessionMethod 1 param → 200
POST
/chatkit/sessions
Create a ChatKit session
CreateChatSessionMethod body → 200
GET
/chatkit/threads/{thread_id}/items
List ChatKit thread items
ListThreadItemsMethod 5 params → 200
GET
/chatkit/threads/{thread_id}
Retrieve a ChatKit thread
GetThreadMethod 1 param → 200
DELETE
/chatkit/threads/{thread_id}
Delete a ChatKit thread
DeleteThreadMethod 1 param → 200
GET
/chatkit/threads
List ChatKit threads
ListThreadsMethod 5 params → 200

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are ChatSessionResource (10 properties), ClientToolCallItem (10 properties), TaskItem (8 properties), UserMessageItem (8 properties). Each schema is shown below with its type and property counts.

WorkflowTracingParam
object
Controls diagnostic tracing during the session.
1 property
ChatkitWorkflow
object
Workflow metadata and state returned for the session.
4 properties 4 required
FileUploadParam
object
Controls whether users can upload files.
3 properties
ClosedStatus
object
Indicates that a thread has been closed.
2 properties 2 required
FileAnnotationSource
object
Attachment source referenced by an annotation.
2 properties 2 required
UserMessageItem
object
User-authored messages within a thread.
8 properties 8 required
OrderEnum
string
ResponseOutputText
object
Assistant response text accompanied by optional annotations.
3 properties 3 required
UrlAnnotationSource
object
URL backing an annotation entry.
2 properties 2 required
ChatSessionFileUpload
object
Upload permissions and limits applied to the session.
3 properties 3 required
UserMessageQuotedText
object
Quoted snippet that the user referenced in their message.
2 properties 2 required
AttachmentType
string
ClientToolCallItem
object
Record of a client side tool invocation initiated by the assistant.
10 properties 10 required
TaskItem
object
Task emitted by the workflow to show progress and status updates.
8 properties 8 required
ToolChoice
object
Tool selection that the assistant should honor when executing the item.
1 property 1 required
TaskGroupTask
object
Task entry that appears within a TaskGroup.
3 properties 3 required
InferenceOptions
object
Model and tool overrides applied when generating the assistant response.
2 properties 2 required
UserMessageInputText
object
Text block that a user contributed to the thread.
2 properties 2 required
UrlAnnotation
object
Annotation that references a URL.
2 properties 2 required
ClientToolCallStatus
string
Attachment
object
Attachment metadata included on thread items.
5 properties 5 required
ChatkitConfigurationParam
object
Optional per-session configuration settings for ChatKit behavior.
3 properties
DeletedThreadResource
object
Confirmation payload returned after deleting a thread.
3 properties 3 required
ThreadItemListResource
object
A paginated list of thread items rendered for the ChatKit API.
5 properties 5 required
CreateChatSessionBody
object
Parameters for provisioning a new ChatKit session.
5 properties 2 required
TaskGroupItem
object
Collection of workflow tasks grouped together in the thread.
6 properties 6 required
WorkflowParam
object
Workflow reference and overrides applied to the chat session.
4 properties 1 required
AutomaticThreadTitlingParam
object
Controls whether ChatKit automatically generates thread titles.
1 property
ThreadListResource
object
A paginated list of ChatKit threads.
5 properties 5 required
ChatSessionAutomaticThreadTitling
object
Automatic thread title preferences for the session.
1 property 1 required
ThreadResource
object
Represents a ChatKit thread and its current status.
6 properties 6 required
ChatSessionResource
object
Represents a ChatKit session and its resolved configuration.
10 properties 10 required
AssistantMessageItem
object
Assistant-authored message within a thread.
6 properties 6 required
ChatSessionStatus
string
WidgetMessageItem
object
Thread item that renders a widget payload.
6 properties 6 required
TaskType
string
ExpiresAfterParam
object
Controls when the session expires relative to an anchor timestamp.
2 properties 2 required
RateLimitsParam
object
Controls request rate limits for the session.
1 property
ChatkitWorkflowTracing
object
Controls diagnostic tracing during the session.
1 property 1 required
LockedStatus
object
Indicates that a thread is locked and cannot accept new input.
2 properties 2 required
HistoryParam
object
Controls how much historical context is retained for the session.
2 properties
ChatSessionChatkitConfiguration
object
ChatKit configuration for the session.
3 properties 3 required
ActiveStatus
object
Indicates that a thread is active.
1 property 1 required
ChatSessionRateLimits
object
Active per-minute request limit for the session.
1 property 1 required
ThreadItem
ChatSessionHistory
object
History retention preferences returned for the session.
2 properties 2 required
FileAnnotation
object
Annotation that references an uploaded file.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openai-chatkit-api-openapi.yml Raw ↑

Other APIs OpenAI publishes across the network.

OpenAI Responses API
AE Profile APIs.io
OpenAI Moderations API
AE Profile APIs.io
OpenAI Batch API
AE Profile APIs.io
OpenAI Vector Stores API
AE Profile APIs.io
OpenAI Uploads API
AE Profile APIs.io
OpenAI Realtime API
AE Profile APIs.io
OpenAI Evals API
AE Profile APIs.io
OpenAI Videos API
AE Profile APIs.io
OpenAI Conversations API
AE Profile APIs.io
OpenAI Containers API
AE Profile APIs.io
OpenAI Skills API
AE Profile APIs.io
OpenAI Agents SDK
AE Profile APIs.io
#ChatKit
← Back to O APIs
API Details
ID
openai:openai-chatkit-api
Base URL
https://api.openai.com
Docs
https://platform.openai.com/docs/assistants/overview
Provider
OpenAI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openai-chatkit-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openai-chatkit-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenAI Chatkit API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.