Skip to content
Lucero
Search
Ctrl
K
Cancel
github
rss
Select theme
Dark
Light
Auto
Docs
usage
markdown
basic
extended
mermaid
starlight
styling
components
expressive code
astro
rss
OpenAPI
starlight-openapi
overview
openAI
Overview
Assistants
Overview
Returns a list of assistants.
Create an assistant with a model and instructions.
Retrieves an assistant.
Modifies an assistant.
Delete an assistant.
Create a thread.
Create a thread and run it in one request.
Retrieves a thread.
Modifies a thread.
Delete a thread.
Returns a list of messages for a given thread.
Create a message.
Retrieve a message.
Modifies a message.
Deletes a message.
Returns a list of runs belonging to a thread.
Create a run.
Retrieves a run.
Modifies a run.
Cancels a run that is `in_progress`.
Returns a list of run steps belonging to a run.
Retrieves a run step.
When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
Audio
Overview
Generates audio from the input text.
Transcribes audio into the input language.
Translates audio into English.
Chat
Overview
Creates a model response for the given chat conversation. Learn more in the [text generation](/docs/guides/text-generation), [vision](/docs/guides/vision), and [audio](/docs/guides/audio) guides.
Completions
Overview
Creates a completion for the provided prompt and parameters.
Embeddings
Overview
Creates an embedding vector representing the input text.
Fine-tuning
Overview
List your organization's fine-tuning jobs
Creates a fine-tuning job which begins the process of creating a new 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)
Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning)
Immediately cancel a fine-tune job.
List checkpoints for a fine-tuning job.
Get status updates for a fine-tuning job.
Batch
Overview
List your organization's batches.
Creates and executes a batch from an uploaded file of requests
Retrieves a batch.
Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.
Files
Overview
Returns a list of files that belong to the user's organization.
Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details. The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models. The Batch API only supports `.jsonl` files up to 100 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input). Please [contact us](https://help.openai.com/) if you need to increase these storage limits.
Returns information about a specific file.
Delete a file.
Returns the contents of the specified file.
Uploads
Overview
Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. For certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case: - [Assistants](/docs/assistants/tools/file-search/supported-files) For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create).
Cancels the Upload. No Parts may be added after an Upload is cancelled.
Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).
Images
Overview
Creates an edited or extended image given an original image and a prompt.
Creates an image given a prompt.
Creates a variation of a given image.
Models
Overview
Lists the currently available models, and provides basic information about each one such as the owner and availability.
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
Moderations
Overview
Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation).
Audit Logs
Overview
List user actions and configuration changes within this organization.
Invites
Returns a list of invites in the organization.
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
Retrieves an invite.
Delete an invite. If the invite has already been accepted, it cannot be deleted.
Projects
Returns a list of projects.
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
Retrieves a project.
Modifies a project in the organization.
Returns a list of API keys in the project.
Retrieves an API key in the project.
Deletes an API key from the project.
Archives a project in the organization. Archived projects cannot be used or updated.
Returns a list of service accounts in the project.
Creates a new service account in the project. This also returns an unredacted API key for the service account.
Retrieves a service account in the project.
Deletes a service account from the project.
Returns a list of users in the project.
Adds a user to the project. Users must already be members of the organization to be added to a project.
Retrieves a user in the project.
Modifies a user's role in the project.
Deletes a user from the project.
Users
Lists all of the users in the organization.
Retrieves a user by their identifier.
Modifies a user's role in the organization.
Deletes a user from the organization.
Vector stores
Returns a list of vector stores.
Create a vector store.
Retrieves a vector store.
Modifies a vector store.
Delete a vector store.
Create a vector store file batch.
Retrieves a vector store file batch.
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
Returns a list of vector store files in a batch.
Returns a list of vector store files.
Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
Retrieves a vector store file.
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.
PokeAPI
Overview
pokemon
ability_list
ability_retrieve
List charecterictics
Get charecterictic
List egg groups
Get egg group
List genders
Get gender
List growth rates
Get growth rate
List move damage classes
Get move damage class
List natures
Get nature
List pokeathlon stats
Get pokeathlon stat
List pokemon
List pokemon colors
Get pokemon color
List pokemon forms
Get pokemon form
List pokemom habitas
Get pokemom habita
List pokemon shapes
Get pokemon shape
List pokemon species
Get pokemon species
Get pokemon
List stats
Get stat
List types
Get types
berries
List berries
List berry firmness
Get berry by firmness
List berry flavors
Get berries by flavor
Get a berry
contests
List contest effects
Get contest effect
List contest types
Get contest type
List super contest effects
Get super contest effect
encounters
List encounter conditions
List encounter condition values
Get encounter condition value
Get encounter condition
List encounter methods
Get encounter method
Get pokemon encounter
evolution
List evolution chains
Get evolution chain
List evolution triggers
Get evolution trigger
games
List genrations
Get genration
List pokedex
Get pokedex
List versions
List version groups
Get version group
Get version
items
List items
List item attributes
Get item attribute
List item categories
Get item category
List item fling effects
Get item fling effect
List item pockets
Get item pocket
Get item
utility
List languages
Get language
location
List locations
List location areas
Get location area
Get location
List pal park areas
Get pal park area
List regions
Get region
machines
List machines
Get machine
moves
List moves
List move meta ailments
Get move meta ailment
List move battle styles
Get move battle style
List move meta categories
Get move meta category
List move learn methods
Get move learn method
List move targets
Get move target
Get move
Stoplight Elements
PokeAPI (Stoplight Elements)
RapiDoc
PokeAPI (RapiDoc)
RSS Feed
github
rss
Select theme
Dark
Light
Auto
Overview
Uploads
Section titled “Uploads”
Use Uploads to upload large files in multiple parts.
