OpenAI API
The OpenAI API provides programmatic access to a family of AI models for tasks such as text completion, chat, embeddings, edits, classifications, audio transcription/translation, image generation and editing, as well as utilities for searching documents, moderating content, managing files, and creating or managing fine‑tuned models.
Latency
674ms p95
Uptime
100.0% 30d
Playground
Verified
live
Endpoints
/engines/{engine_id}
Retrieves a model instance, providing basic information about it such as the owner and availability.
/answers
Answers the specified question using the provided documents and examples. The endpoint first [searches](/docs/api-reference/searches) over provided documents or files to find relevant context. The relevant context is combined with the provided examples and question to create the prompt for [completion](/docs/api-reference/completions).
/audio/transcriptions
Transcribes audio into the input language.
/audio/translations
Translates audio into into English.
/chat/completions
Creates a completion for the chat message
/classifications
Classifies the specified `query` using provided examples. The endpoint first [searches](/docs/api-reference/searches) over the labeled examples to select the ones most relevant for the particular query. Then, the relevant examples are combined with the query to construct a prompt to produce the final label via the [completions](/docs/api-reference/completions) endpoint. Labeled examples can be provided via an uploaded `file`, or explicitly listed in the request using the `examples` parameter for quick tests and small scale use cases.
/completions
Creates a completion for the provided prompt and parameters
/edits
Creates a new edit for the provided input, instruction, and parameters.
/embeddings
Creates an embedding vector representing the input text.
/engines
Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.
/engines/{engine_id}/search
The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them. To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number of documents. These documents will be returned along with their search scores. The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
/files
Returns a list of files that belong to the user's organization.
/files
Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
/files/{file_id}
Delete a file.
/files/{file_id}
Returns information about a specific file.
/files/{file_id}/content
Returns the contents of the specified file
/fine-tunes
List your organization's fine-tuning jobs
/fine-tunes
Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
/fine-tunes/{fine_tune_id}
Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning)
/fine-tunes/{fine_tune_id}/cancel
Immediately cancel a fine-tune job.
/fine-tunes/{fine_tune_id}/events
Get fine-grained status updates for a fine-tune job.
/images/edits
Creates an edited or extended image given an original image and a prompt.
/images/generations
Creates an image given a prompt.
/images/variations
Creates a variation of a given image.
/models
Lists the currently available models, and provides basic information about each one such as the owner and availability.
/models/{model}
Delete a fine-tuned model. You must have the Owner role in your organization.
/models/{model}
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
/moderations
Classifies if text violates OpenAI's Content Policy
28 endpoints auto-detected
curl -X GET \
"https://api.openai.com/v1/engines/{engine_id}"api.openai.com · HTTPS only