Crate openai_openapi_http Copy item path Source ActivateOrganizationCertificates ActivateProjectCertificates AdminApiKeysCreate AdminApiKeysDelete AdminApiKeysGet AdminApiKeysList ApiError ArchiveProject CancelBatch CancelEvalRun CancelFineTuningJob CancelResponse CancelRun CancelUpload CancelVectorStoreFileBatch CompleteUpload CreateAssistant CreateBatch CreateChatCompletion CreateChatCompletionStream CreateCompletion CreateEmbedding CreateEval CreateEvalRun CreateFineTuningCheckpointPermission CreateFineTuningJob CreateImage CreateMessage CreateModeration CreateProject CreateProjectServiceAccount CreateProjectUser CreateRealtimeSession CreateRealtimeTranscriptionSession CreateResponse CreateResponseStream CreateRun CreateSpeechStream CreateThreadAndRun CreateUpload CreateVectorStore CreateVectorStoreFile CreateVectorStoreFileBatch DeactivateOrganizationCertificates DeactivateProjectCertificates DeleteAssistant DeleteCertificate DeleteChatCompletion DeleteEval DeleteEvalRun DeleteFile DeleteFineTuningCheckpointPermission DeleteInvite DeleteMessage DeleteModel DeleteProjectApiKey DeleteProjectServiceAccount DeleteProjectUser DeleteThread DeleteUser DeleteVectorStore DeleteVectorStoreFile DownloadFile EventStream GetAssistant GetCertificate GetChatCompletion GetChatCompletionMessages GetEval GetEvalRun GetEvalRunOutputItem GetEvalRunOutputItems GetEvalRuns GetMessage GetResponse GetRun GetRunStep GetThread GetVectorStore GetVectorStoreFile GetVectorStoreFileBatch InviteUser ListAssistants ListAuditLogs ListBatches ListChatCompletions ListContainerFiles ListContainers ListEvals ListFiles ListFilesInVectorStoreBatch ListFineTuningCheckpointPermissions ListFineTuningEvents ListFineTuningJobCheckpoints ListInputItems ListInvites ListMessages ListModels ListOrganizationCertificates ListPaginatedFineTuningJobs ListProjectApiKeys ListProjectCertificates ListProjectRateLimits ListProjectServiceAccounts ListProjectUsers ListProjects ListRunSteps ListRuns ListUsers ListVectorStoreFiles ListVectorStores ModifyAssistant ModifyCertificate ModifyMessage ModifyProject ModifyProjectUser ModifyRun ModifyThread ModifyUser ModifyVectorStore PauseFineTuningJob ResumeFineTuningJob RetrieveBatch RetrieveContainer RetrieveContainerFile RetrieveFile RetrieveFineTuningJob RetrieveInvite RetrieveModel RetrieveProject RetrieveProjectApiKey RetrieveProjectServiceAccount RetrieveProjectUser RetrieveUser RetrieveVectorStoreFileContent RunGrader SearchVectorStore SubmitToolOuputsToRun UpdateChatCompletion UpdateEval UpdateProjectRateLimits UpdateVectorStoreFileAttributes UploadCertificate UsageAudioSpeeches UsageAudioTranscriptions UsageCodeInterpreterSessions UsageCompletions UsageCosts UsageEmbeddings UsageImages UsageModerations UsageVectorStores ValidateGrader Error activate_organization_certificates Activate certificates at the organization level. activate_project_certificates Activate certificates at the project level. admin_api_keys_create Create an organization admin API key admin_api_keys_delete Delete an organization admin API key admin_api_keys_get Retrieve a single organization API key admin_api_keys_list List organization API keys archive_project Archives a project in the organization. Archived projects cannot be used or updated. cancel_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. cancel_eval_run Cancel an ongoing evaluation run. cancel_fine_tuning_job Immediately cancel a fine-tune job. cancel_response Cancels a model response with the given ID. Only responses created with
the background parameter set to true can be cancelled.
Learn more . cancel_run Cancels a run that is in_progress. cancel_upload Cancels the Upload. No Parts may be added after an Upload is cancelled. cancel_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. complete_upload Completes the Upload . create_assistant Create an assistant with a model and instructions. create_batch Creates and executes a batch from an uploaded file of requests create_chat_completion Starting a new project? We recommend trying Responses
to take advantage of the latest OpenAI platform features. Compare
Chat Completions with Responses .create_chat_completion_stream Starting a new project? We recommend trying Responses
to take advantage of the latest OpenAI platform features. Compare
Chat Completions with Responses .create_completion Creates a completion for the provided prompt and parameters. create_embedding Creates an embedding vector representing the input text. create_eval Create the structure of an evaluation that can be used to test a model’s performance.
An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.
For more information, see the Evals guide . create_eval_run Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation. create_fine_tuning_checkpoint_permission NOTE: Calling this endpoint requires an admin API key .create_fine_tuning_job Creates a fine-tuning job which begins the process of creating a new model from a given dataset. create_image Creates an image given a prompt. Learn more . create_message Create a message. create_moderation Classifies if text and/or image inputs are potentially harmful. Learn
more in the moderation guide . create_project Create a new project in the organization. Projects can be created and archived, but cannot be deleted. create_project_service_account Creates a new service account in the project. This also returns an unredacted API key for the service account. create_project_user Adds a user to the project. Users must already be members of the organization to be added to a project. create_realtime_session Create an ephemeral API token for use in client-side applications with the
Realtime API. Can be configured with the same session parameters as the
session.update client event. create_realtime_transcription_session Create an ephemeral API token for use in client-side applications with the
Realtime API specifically for realtime transcriptions.
Can be configured with the same session parameters as the transcription_session.update client event. create_response Creates a model response. Provide text or
image inputs to generate text
or JSON outputs. Have the model call
your own custom code or use built-in
tools like web search
or file search to use your own data
as input for the model’s response. create_response_stream Creates a model response. Provide text or
image inputs to generate text
or JSON outputs. Have the model call
your own custom code or use built-in
tools like web search
or file search to use your own data
as input for the model’s response. create_run Create a run. create_speech_stream Generates audio from the input text. create_thread_and_run Create a thread and run it in one request. create_upload Creates an intermediate Upload object
that you can add Parts to.
Currently, an Upload can accept at most 8 GB in total and expires after an
hour after you create it. create_vector_store Create a vector store. create_vector_store_file Create a vector store file by attaching a File to a vector store . create_vector_store_file_batch Create a vector store file batch. deactivate_organization_certificates Deactivate certificates at the organization level. deactivate_project_certificates Deactivate certificates at the project level. You can atomically and
idempotently deactivate up to 10 certificates at a time. delete_assistant Delete an assistant. delete_certificate Delete a certificate from the organization. delete_chat_completion Delete a stored chat completion. Only Chat Completions that have been
created with the store parameter set to true can be deleted. delete_eval Delete an evaluation. delete_eval_run Delete an eval run. delete_file Delete a file. delete_fine_tuning_checkpoint_permission NOTE: This endpoint requires an admin API key .delete_invite Delete an invite. If the invite has already been accepted, it cannot be deleted. delete_message Deletes a message. delete_model Delete a fine-tuned model. You must have the Owner role in your organization to delete a model. delete_project_api_key Deletes an API key from the project. delete_project_service_account Deletes a service account from the project. delete_project_user Deletes a user from the project. delete_thread Delete a thread. delete_user Deletes a user from the organization. delete_vector_store Delete a vector store. delete_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 endpoint. download_file Returns the contents of the specified file. get_assistant Retrieves an assistant. get_certificate Get a certificate that has been uploaded to the organization. get_chat_completion Get a stored chat completion. Only Chat Completions that have been created
with the store parameter set to true will be returned. get_chat_completion_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. get_eval Get an evaluation by ID. get_eval_run Get an evaluation run by ID. get_eval_run_output_item Get an evaluation run output item by ID. get_eval_run_output_items Get a list of output items for an evaluation run. get_eval_runs Get a list of runs for an evaluation. get_message Retrieve a message. get_response Retrieves a model response with the given ID. get_run Retrieves a run. get_run_step Retrieves a run step. get_thread Retrieves a thread. get_vector_store Retrieves a vector store. get_vector_store_file Retrieves a vector store file. get_vector_store_file_batch Retrieves a vector store file batch. invite_user Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization. list_assistants Returns a list of assistants. list_audit_logs List user actions and configuration changes within this organization. list_batches List your organization’s batches. list_chat_completions List stored Chat Completions. Only Chat Completions that have been stored
with the store parameter set to true will be returned. list_container_files List Container files list_containers List Containers list_evals List evaluations for a project. list_files Returns a list of files. list_files_in_vector_store_batch Returns a list of vector store files in a batch. list_fine_tuning_checkpoint_permissions NOTE: This endpoint requires an admin API key .list_fine_tuning_events Get status updates for a fine-tuning job. list_fine_tuning_job_checkpoints List checkpoints for a fine-tuning job. list_input_items Returns a list of input items for a given response. list_invites Returns a list of invites in the organization. list_messages Returns a list of messages for a given thread. list_models Lists the currently available models, and provides basic information about each one such as the owner and availability. list_organization_certificates List uploaded certificates for this organization. list_paginated_fine_tuning_jobs List your organization’s fine-tuning jobs list_project_api_keys Returns a list of API keys in the project. list_project_certificates List certificates for this project. list_project_rate_limits Returns the rate limits per model for a project. list_project_service_accounts Returns a list of service accounts in the project. list_project_users Returns a list of users in the project. list_projects Returns a list of projects. list_run_steps Returns a list of run steps belonging to a run. list_runs Returns a list of runs belonging to a thread. list_users Lists all of the users in the organization. list_vector_store_files Returns a list of vector store files. list_vector_stores Returns a list of vector stores. modify_assistant Modifies an assistant. modify_certificate Modify a certificate. Note that only the name can be modified. modify_message Modifies a message. modify_project Modifies a project in the organization. modify_project_user Modifies a user’s role in the project. modify_run Modifies a run. modify_thread Modifies a thread. modify_user Modifies a user’s role in the organization. modify_vector_store Modifies a vector store. pause_fine_tuning_job Pause a fine-tune job. resume_fine_tuning_job Resume a fine-tune job. retrieve_batch Retrieves a batch. retrieve_container Retrieve Container retrieve_container_file Retrieve Container File retrieve_file Returns information about a specific file. retrieve_fine_tuning_job Get info about a fine-tuning job. retrieve_invite Retrieves an invite. retrieve_model Retrieves a model instance, providing basic information about the model such as the owner and permissioning. retrieve_project Retrieves a project. retrieve_project_api_key Retrieves an API key in the project. retrieve_project_service_account Retrieves a service account in the project. retrieve_project_user Retrieves a user in the project. retrieve_user Retrieves a user by their identifier. retrieve_vector_store_file_content Retrieve the parsed contents of a vector store file. run_grader Run a grader. search_vector_store Search a vector store for relevant chunks based on a query and file attributes filter. submit_tool_ouputs_to_run 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. update_chat_completion 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 metadata field. update_eval Update certain properties of an evaluation. update_project_rate_limits Updates a project rate limit. update_vector_store_file_attributes Update attributes on a vector store file. upload_certificate Upload a certificate to the organization. This does not automatically activate the certificate. usage_audio_speeches Get audio speeches usage details for the organization. usage_audio_transcriptions Get audio transcriptions usage details for the organization. usage_code_interpreter_sessions Get code interpreter sessions usage details for the organization. usage_completions Get completions usage details for the organization. usage_costs Get costs details for the organization. usage_embeddings Get embeddings usage details for the organization. usage_images Get images usage details for the organization. usage_moderations Get moderations usage details for the organization. usage_vector_stores Get vector stores usage details for the organization. validate_grader Validate a grader.