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

OpenAI Chat API

Given a list of messages comprising a conversation, the model will return a response.

OpenAI Chat 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 Chat. 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 3 paths, and defines 21 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 operations 3 paths 21 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://api.openai.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

OpenAI Chat 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 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Chat 6

Given a list of messages comprising a conversation, the model will return a response.

POST
/chat/completions
OpenAI Creates a model response for the given chat conversation.
createChatCompletion body → 200
GET
/chat/completions
List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.
listChatCompletions 5 params → 200
GET
/chat/completions/{completion_id}
Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
getChatCompletion 1 param → 200
POST
/chat/completions/{completion_id}
Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadat…
updateChatCompletion 1 param body → 200
DELETE
/chat/completions/{completion_id}
Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.
deleteChatCompletion 1 param → 200
GET
/chat/completions/{completion_id}/messages
Get the messages in a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
getChatCompletionMessages 4 params → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are CreateChatCompletionRequest (21 properties), CreateChatCompletionResponse_3 (8 properties), ChatCompletionResponseMessage (7 properties), CreateChatCompletionResponse (7 properties). Each schema is shown below with its type and property counts.

ChatCompletionRequestMessageContentPartImage
object
Learn about [image inputs](/docs/guides/vision).
2 properties 2 required
ChatCompletionMessageList
object
An object representing a list of chat completion messages.
5 properties 5 required
CreateChatCompletionResponse_3
object
Represents a chat completion response returned by model, based on the provided input.
8 properties 5 required
ChatCompletionRequestMessageContentPartText
object
Learn about [text inputs](/docs/guides/text-generation).
2 properties 2 required
CreateChatCompletionRequest
object
21 properties 2 required
ChatCompletionTokenLogprob
object
4 properties 4 required
ServiceTier
ToolCall
object
3 properties 3 required
ContentPart
object
3 properties 1 required
ChatCompletionMessage
object
5 properties 2 required
CreateChatCompletionResponse
object
Represents a chat completion response returned by model, based on the provided input.
7 properties 5 required
CompletionUsage_2
object
Usage statistics for the completion request.
5 properties 3 required
ChatCompletionResponseMessage
object
A chat completion message generated by the model.
7 properties 3 required
CompletionUsage
object
5 properties 3 required
ChatCompletionTool
object
2 properties 2 required
Metadata
ChatCompletionDeleted
object
3 properties 3 required
ChatCompletionMessageToolCall
object
A call to a function tool created by the model.
3 properties 3 required
ChatCompletionList
object
An object representing a list of Chat Completions.
5 properties 5 required
ChatCompletionMessageCustomToolCall
object
A call to a custom tool created by the model.
3 properties 3 required
ChatCompletionMessageToolCalls
array
The tool calls generated by the model, such as function calls.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openai-chat-api-openapi.yml Raw ↑

Other APIs OpenAI publishes across the network.

OpenAI Responses API
OpenAI Moderations API
OpenAI Batch API
OpenAI Vector Stores API
OpenAI Uploads API
OpenAI Realtime API
OpenAI Evals API
OpenAI Videos API
OpenAI Conversations API
OpenAI Containers API
OpenAI ChatKit API
OpenAI Skills API
Where this information came from

This is an independent, third-party profile of OpenAI Chat 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.