OpenAI Chatkit API is one of 51 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.0.0, at version 2.0.0.
Requests are made against a single base URL, https://api.openai.com/v1.
6 operations5 paths47 schemas1 DELETE3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
OpenAI Chatkit API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
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 an active ChatKit session and return its most recent metadata. Cancelling prevents new requests from using the issued client secret.
CancelChatSessionMethod1 param→ 200
POST
/chatkit/sessions
Create a ChatKit session.
CreateChatSessionMethodbody→ 200
GET
/chatkit/threads/{thread_id}/items
List items that belong to a ChatKit thread.
ListThreadItemsMethod5 params→ 200
GET
/chatkit/threads/{thread_id}
Retrieve a ChatKit thread by its identifier.
GetThreadMethod1 param→ 200
DELETE
/chatkit/threads/{thread_id}
Delete a ChatKit thread along with its items and stored attachments.
DeleteThreadMethod1 param→ 200
GET
/chatkit/threads
List ChatKit threads with optional pagination and user filters.
ListThreadsMethod5 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), UserMessageItem (8 properties), TaskItem (8 properties). Each schema is shown below with its type and property counts.
UserMessageItem
object
User-authored messages within a thread.
8 properties8 required
ChatkitWorkflowTracing
object
Controls diagnostic tracing during the session.
1 property1 required
ThreadListResource
object
A paginated list of ChatKit threads.
5 properties5 required
ChatSessionFileUpload
object
Upload permissions and limits applied to the session.
3 properties3 required
WorkflowParam
object
Workflow reference and overrides applied to the chat session.
4 properties1 required
ClientToolCallStatus
string
UrlAnnotation
object
Annotation that references a URL.
2 properties2 required
ThreadResource
object
Represents a ChatKit thread and its current status.
6 properties6 required
AssistantMessageItem
object
Assistant-authored message within a thread.
6 properties6 required
DeletedThreadResource
object
Confirmation payload returned after deleting a thread.
3 properties3 required
ToolChoice
object
Tool selection that the assistant should honor when executing the item.
1 property1 required
ChatSessionRateLimits
object
Active per-minute request limit for the session.
1 property1 required
UserMessageInputText
object
Text block that a user contributed to the thread.
2 properties2 required
ChatkitConfigurationParam
object
Optional per-session configuration settings for ChatKit behavior.
3 properties
RateLimitsParam
object
Controls request rate limits for the session.
1 property
ChatSessionStatus
string
UrlAnnotationSource
object
URL backing an annotation entry.
2 properties2 required
TaskItem
object
Task emitted by the workflow to show progress and status updates.
8 properties8 required
CreateChatSessionBody
object
Parameters for provisioning a new ChatKit session.
5 properties2 required
ChatkitWorkflow
object
Workflow metadata and state returned for the session.
4 properties4 required
FileAnnotationSource
object
Attachment source referenced by an annotation.
2 properties2 required
TaskGroupTask
object
Task entry that appears within a TaskGroup.
3 properties3 required
ClientToolCallItem
object
Record of a client side tool invocation initiated by the assistant.
10 properties10 required
Attachment
object
Attachment metadata included on thread items.
5 properties5 required
TaskType
string
InferenceOptions
object
Model and tool overrides applied when generating the assistant response.
2 properties2 required
UserMessageQuotedText
object
Quoted snippet that the user referenced in their message.
2 properties2 required
TaskGroupItem
object
Collection of workflow tasks grouped together in the thread.
6 properties6 required
ThreadItemListResource
object
A paginated list of thread items rendered for the ChatKit API.
5 properties5 required
ClosedStatus
object
Indicates that a thread has been closed.
2 properties2 required
ChatSessionResource
object
Represents a ChatKit session and its resolved configuration.
10 properties10 required
ExpiresAfterParam
object
Controls when the session expires relative to an anchor timestamp.
2 properties2 required
HistoryParam
object
Controls how much historical context is retained for the session.
2 properties
LockedStatus
object
Indicates that a thread is locked and cannot accept new input.
2 properties2 required
ThreadItem
FileUploadParam
object
Controls whether users can upload files.
3 properties
ActiveStatus
object
Indicates that a thread is active.
1 property1 required
FileAnnotation
object
Annotation that references an uploaded file.
2 properties2 required
OrderEnum
string
WorkflowTracingParam
object
Controls diagnostic tracing during the session.
1 property
AttachmentType
string
ChatSessionHistory
object
History retention preferences returned for the session.
2 properties2 required
ResponseOutputText
object
Assistant response text accompanied by optional annotations.
3 properties3 required
ChatSessionAutomaticThreadTitling
object
Automatic thread title preferences for the session.
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.
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.
