OpenAI Models API
List and describe the various models available in the API. You can refer to the Models documentation to understand what models are available and the differences between them.
OpenAPI Specification
openapi: 3.0.0
info:
title: 'OpenAI models'
description: Needs description.
version: 2.0.0
termsOfService: https://openai.com/policies/terms-of-use
contact:
name: OpenAI Support
url: https://help.openai.com/
license:
name: MIT
url: https://github.com/openai/openai-openapi/blob/master/LICENSE
servers:
- url: https://api.openai.com/v1
tags:
- name: Models
description: List and describe the various models available in the API.
paths:
/models:
get:
operationId: listModels
tags:
- Models
summary: >-
OpenAI Lists the currently available models, and provides basic information about each one such as the owner and availability.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListModelsResponse'
x-oaiMeta:
name: List models
group: models
returns: A list of [model](/docs/api-reference/models/object) objects.
examples:
request:
curl: |
curl https://api.openai.com/v1/models \
-H "Authorization: Bearer $OPENAI_API_KEY"
python: |
from openai import OpenAI
client = OpenAI()
client.models.list()
node.js: |-
import OpenAI from "openai";
const openai = new OpenAI();
async function main() {
const list = await openai.models.list();
for await (const model of list) {
console.log(model);
}
}
main();
response: |
{
"object": "list",
"data": [
{
"id": "model-id-0",
"object": "model",
"created": 1686935002,
"owned_by": "organization-owner"
},
{
"id": "model-id-1",
"object": "model",
"created": 1686935002,
"owned_by": "organization-owner",
},
{
"id": "model-id-2",
"object": "model",
"created": 1686935002,
"owned_by": "openai"
},
],
"object": "list"
}
/models/{model}:
get:
operationId: retrieveModel
tags:
- Models
summary: >-
OpenAI Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
parameters:
- in: path
name: model
required: true
schema:
type: string
example: gpt-3.5-turbo
description: The ID of the model to use for this request
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Model'
x-oaiMeta:
name: Retrieve model
group: models
returns: >-
The [model](/docs/api-reference/models/object) object matching the
specified ID.
examples:
request:
curl: |
curl https://api.openai.com/v1/models/VAR_model_id \
-H "Authorization: Bearer $OPENAI_API_KEY"
python: |
from openai import OpenAI
client = OpenAI()
client.models.retrieve("VAR_model_id")
node.js: |-
import OpenAI from "openai";
const openai = new OpenAI();
async function main() {
const model = await openai.models.retrieve("gpt-3.5-turbo");
console.log(model);
}
main();
response: |
{
"id": "VAR_model_id",
"object": "model",
"created": 1686935002,
"owned_by": "openai"
}
delete:
operationId: deleteModel
tags:
- Models
summary: >-
OpenAI Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
parameters:
- in: path
name: model
required: true
schema:
type: string
example: ft:gpt-3.5-turbo:acemeco:suffix:abc123
description: The model to delete
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteModelResponse'
x-oaiMeta:
name: Delete a fine-tuned model
group: models
returns: Deletion status.
examples:
request:
curl: >
curl
https://api.openai.com/v1/models/ft:gpt-3.5-turbo:acemeco:suffix:abc123
\
-X DELETE \
-H "Authorization: Bearer $OPENAI_API_KEY"
python: |
from openai import OpenAI
client = OpenAI()
client.models.delete("ft:gpt-3.5-turbo:acemeco:suffix:abc123")
node.js: |-
import OpenAI from "openai";
const openai = new OpenAI();
async function main() {
const model = await openai.models.del("ft:gpt-3.5-turbo:acemeco:suffix:abc123");
console.log(model);
}
main();
response: |
{
"id": "ft:gpt-3.5-turbo:acemeco:suffix:abc123",
"object": "model",
"deleted": true
}
components:
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
schemas:
ListModelsResponse:
type: object
properties:
object:
type: string
enum:
- list
data:
type: array
items:
$ref: '#/components/schemas/Model'
required:
- object
- data
Model:
title: Model
description: Describes an OpenAI model offering that can be used with the API.
properties:
id:
type: string
description: The model identifier, which can be referenced in the API endpoints.
created:
type: integer
description: The Unix timestamp (in seconds) when the model was created.
object:
type: string
description: The object type, which is always "model".
enum:
- model
owned_by:
type: string
description: The organization that owns the model.
required:
- id
- object
- created
- owned_by
x-oaiMeta:
name: The model object
example: |
{
"id": "VAR_model_id",
"object": "model",
"created": 1686935002,
"owned_by": "openai"
}
DeleteModelResponse:
type: object
properties:
id:
type: string
deleted:
type: boolean
object:
type: string
required:
- id
- object
- deleted
security:
- ApiKeyAuth: []
x-oaiMeta:
groups:
- id: audio
title: Audio
description: |
Learn how to turn audio into text or text into audio.
Related guide: [Speech to text](/docs/guides/speech-to-text)
sections:
- type: endpoint
key: createSpeech
path: createSpeech
- type: endpoint
key: createTranscription
path: createTranscription
- type: endpoint
key: createTranslation
path: createTranslation
- id: chat
title: Chat
description: >
Given a list of messages comprising a conversation, the model will
return a response.
Related guide: [Chat Completions](/docs/guides/text-generation)
sections:
- type: endpoint
key: createChatCompletion
path: create
- type: object
key: CreateChatCompletionResponse
path: object
- type: object
key: CreateChatCompletionStreamResponse
path: streaming
- id: embeddings
title: Embeddings
description: >
Get a vector representation of a given input that can be easily consumed
by machine learning models and algorithms.
Related guide: [Embeddings](/docs/guides/embeddings)
sections:
- type: endpoint
key: createEmbedding
path: create
- type: object
key: Embedding
path: object
- id: fine-tuning
title: Fine-tuning
description: >
Manage fine-tuning jobs to tailor a model to your specific training
data.
Related guide: [Fine-tune models](/docs/guides/fine-tuning)
sections:
- type: endpoint
key: createFineTuningJob
path: create
- type: endpoint
key: listPaginatedFineTuningJobs
path: list
- type: endpoint
key: listFineTuningEvents
path: list-events
- type: endpoint
key: retrieveFineTuningJob
path: retrieve
- type: endpoint
key: cancelFineTuningJob
path: cancel
- type: object
key: FineTuningJob
path: object
- type: object
key: FineTuningJobEvent
path: event-object
- id: files
title: Files
description: >
Files are used to upload documents that can be used with features like
[Assistants](/docs/api-reference/assistants) and
[Fine-tuning](/docs/api-reference/fine-tuning).
sections:
- type: endpoint
key: createFile
path: create
- type: endpoint
key: listFiles
path: list
- type: endpoint
key: retrieveFile
path: retrieve
- type: endpoint
key: deleteFile
path: delete
- type: endpoint
key: downloadFile
path: retrieve-contents
- type: object
key: OpenAIFile
path: object
- id: images
title: Images
description: >
Given a prompt and/or an input image, the model will generate a new
image.
Related guide: [Image generation](/docs/guides/images)
sections:
- type: endpoint
key: createImage
path: create
- type: endpoint
key: createImageEdit
path: createEdit
- type: endpoint
key: createImageVariation
path: createVariation
- type: object
key: Image
path: object
- id: models
title: Models
description: >
List and describe the various models available in the API. You can refer
to the [Models](/docs/models) documentation to understand what models
are available and the differences between them.
sections:
- type: endpoint
key: listModels
path: list
- type: endpoint
key: retrieveModel
path: retrieve
- type: endpoint
key: deleteModel
path: delete
- type: object
key: Model
path: object
- id: moderations
title: Moderations
description: >
Given a input text, outputs if the model classifies it as violating
OpenAI's content policy.
Related guide: [Moderations](/docs/guides/moderation)
sections:
- type: endpoint
key: createModeration
path: create
- type: object
key: CreateModerationResponse
path: object
- id: assistants
title: Assistants
beta: true
description: |
Build assistants that can call models and use tools to perform tasks.
[Get started with the Assistants API](/docs/assistants)
sections:
- type: endpoint
key: createAssistant
path: createAssistant
- type: endpoint
key: createAssistantFile
path: createAssistantFile
- type: endpoint
key: listAssistants
path: listAssistants
- type: endpoint
key: listAssistantFiles
path: listAssistantFiles
- type: endpoint
key: getAssistant
path: getAssistant
- type: endpoint
key: getAssistantFile
path: getAssistantFile
- type: endpoint
key: modifyAssistant
path: modifyAssistant
- type: endpoint
key: deleteAssistant
path: deleteAssistant
- type: endpoint
key: deleteAssistantFile
path: deleteAssistantFile
- type: object
key: AssistantObject
path: object
- type: object
key: AssistantFileObject
path: file-object
- id: threads
title: Threads
beta: true
description: |
Create threads that assistants can interact with.
Related guide: [Assistants](/docs/assistants/overview)
sections:
- type: endpoint
key: createThread
path: createThread
- type: endpoint
key: getThread
path: getThread
- type: endpoint
key: modifyThread
path: modifyThread
- type: endpoint
key: deleteThread
path: deleteThread
- type: object
key: ThreadObject
path: object
- id: messages
title: Messages
beta: true
description: |
Create messages within threads
Related guide: [Assistants](/docs/assistants/overview)
sections:
- type: endpoint
key: createMessage
path: createMessage
- type: endpoint
key: listMessages
path: listMessages
- type: endpoint
key: listMessageFiles
path: listMessageFiles
- type: endpoint
key: getMessage
path: getMessage
- type: endpoint
key: getMessageFile
path: getMessageFile
- type: endpoint
key: modifyMessage
path: modifyMessage
- type: object
key: MessageObject
path: object
- type: object
key: MessageFileObject
path: file-object
- id: runs
title: Runs
beta: true
description: |
Represents an execution run on a thread.
Related guide: [Assistants](/docs/assistants/overview)
sections:
- type: endpoint
key: createRun
path: createRun
- type: endpoint
key: createThreadAndRun
path: createThreadAndRun
- type: endpoint
key: listRuns
path: listRuns
- type: endpoint
key: listRunSteps
path: listRunSteps
- type: endpoint
key: getRun
path: getRun
- type: endpoint
key: getRunStep
path: getRunStep
- type: endpoint
key: modifyRun
path: modifyRun
- type: endpoint
key: submitToolOuputsToRun
path: submitToolOutputs
- type: endpoint
key: cancelRun
path: cancelRun
- type: object
key: RunObject
path: object
- type: object
key: RunStepObject
path: step-object
- id: completions
title: Completions
legacy: true
description: >
Given a prompt, the model will return one or more predicted completions
along with the probabilities of alternative tokens at each position.
Most developer should use our [Chat Completions
API](/docs/guides/text-generation/text-generation-models) to leverage
our best and newest models. Most models that support the legacy
Completions endpoint [will be shut off on January 4th,
2024](/docs/deprecations/2023-07-06-gpt-and-embeddings).
sections:
- type: endpoint
key: createCompletion
path: create
- type: object
key: CreateCompletionResponse
path: object