Engines
The Engines endpoints are deprecated.
Please use their replacement, Models, instead. Learn more.
These endpoints describe and provide access to the various engines available in the API.
List engines Deprecated
GET https://api.openai.com/v1/engines
Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.
Example request:
curl:
curl https://api.openai.com/v1/engines \
-H "Authorization: Bearer $OPENAI_API_KEY"
python:
import os
import openai
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Engine.list()
node.js:
const { Configuration, OpenAIApi } = require("openai");
const configuration = new Configuration({
apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.listEngines();
Response:
{
"data": [
{
"id": "engine-id-0",
"object": "engine",
"owner": "organization-owner",
"ready": true
},
{
"id": "engine-id-2",
"object": "engine",
"owner": "organization-owner",
"ready": true
},
{
"id": "engine-id-3",
"object": "engine",
"owner": "openai",
"ready": false
},
],
"object": "list"
}
Retrieve engine Deprecated
GET https://api.openai.com/v1/engines/{engine_id}
Retrieves a model instance, providing basic information about it such as the owner and availability.
Path parameters
engine_idstringRequired
The ID of the engine to use for this request
Supported models:
- babbage
- davinci
- text-davinci-001
- ada
- text-curie-001
- text-davinci-003
- text-ada-001
- curie-instruct-beta
- davinci-instruct-beta
- text-babbage-001
- curie
- text-davinci-002
Example request:
curl:
curl https://api.openai.com/v1/engines/babbage \
-H "Authorization: Bearer $OPENAI_API_KEY"
python:
import os
import openai
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Engine.retrieve("babbage")
node.js:
const { Configuration, OpenAIApi } = require("openai");
const configuration = new Configuration({
apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.retrieveEngine("babbage");
Response:
{
"id": "babbage",
"object": "engine",
"owner": "openai",
"ready": true
}