The openai-openapi-client Reference Manual

4.1.1 openai-openapi-client/openai-openapi-client.asd

Source

openai-openapi-client.asd.

Parent Component

openai-openapi-client (system).

ASDF Systems

openai-openapi-client.

---

4.1.2 openai-openapi-client/src/main.lisp

Source

openai-openapi-client.asd.

Parent Component

src (module).

Packages

openai-openapi-client.

Public Interface

• *authorization* (special variable).
• *bearer* (special variable).
• *cookie* (special variable).
• *headers* (special variable).
• *parse* (special variable).
• *server* (special variable).

Internals

• *query* (special variable).
• delete/assistants/{assistant_id} (function).
• delete/files/{file_id} (function).
• delete/models/{model} (function).
• delete/threads/{thread_id} (function).
• delete/threads/{thread_id}/messages/{message_id} (function).
• delete/vector_stores/{vector_store_id} (function).
• delete/vector_stores/{vector_store_id}/files/{file_id} (function).
• get/assistants (function).
• get/assistants/{assistant_id} (function).
• get/batches (function).
• get/batches/{batch_id} (function).
• get/files (function).
• get/files/{file_id} (function).
• get/files/{file_id}/content (function).
• get/fine_tuning/jobs (function).
• get/fine_tuning/jobs/{fine_tuning_job_id} (function).
• get/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints (function).
• get/fine_tuning/jobs/{fine_tuning_job_id}/events (function).
• get/models (function).
• get/models/{model} (function).
• get/threads/{thread_id} (function).
• get/threads/{thread_id}/messages (function).
• get/threads/{thread_id}/messages/{message_id} (function).
• get/threads/{thread_id}/runs (function).
• get/threads/{thread_id}/runs/{run_id} (function).
• get/threads/{thread_id}/runs/{run_id}/steps (function).
• get/threads/{thread_id}/runs/{run_id}/steps/{step_id} (function).
• get/vector_stores (function).
• get/vector_stores/{vector_store_id} (function).
• get/vector_stores/{vector_store_id}/file_batches/{batch_id} (function).
• get/vector_stores/{vector_store_id}/file_batches/{batch_id}/files (function).
• get/vector_stores/{vector_store_id}/files (function).
• get/vector_stores/{vector_store_id}/files/{file_id} (function).
• post/assistants (function).
• post/assistants/{assistant_id} (function).
• post/audio/speech (function).
• post/audio/transcriptions (function).
• post/audio/translations (function).
• post/batches (function).
• post/batches/{batch_id}/cancel (function).
• post/chat/completions (function).
• post/completions (function).
• post/embeddings (function).
• post/files (function).
• post/fine_tuning/jobs (function).
• post/fine_tuning/jobs/{fine_tuning_job_id}/cancel (function).
• post/images/edits (function).
• post/images/generations (function).
• post/images/variations (function).
• post/moderations (function).
• post/threads (function).
• post/threads/runs (function).
• post/threads/{thread_id} (function).
• post/threads/{thread_id}/messages (function).
• post/threads/{thread_id}/messages/{message_id} (function).
• post/threads/{thread_id}/runs (function).
• post/threads/{thread_id}/runs/{run_id} (function).
• post/threads/{thread_id}/runs/{run_id}/cancel (function).
• post/threads/{thread_id}/runs/{run_id}/submit_tool_outputs (function).
• post/uploads (function).
• post/uploads/{upload_id}/cancel (function).
• post/uploads/{upload_id}/complete (function).
• post/uploads/{upload_id}/parts (function).
• post/vector_stores (function).
• post/vector_stores/{vector_store_id} (function).
• post/vector_stores/{vector_store_id}/file_batches (function).
• post/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel (function).
• post/vector_stores/{vector_store_id}/files (function).

---

6.1.1 Special variables

Special Variable: *authorization* ¶

Package

openai-openapi-client.

Source

main.lisp.

Special Variable: *bearer* ¶

Package

openai-openapi-client.

Source

main.lisp.

Special Variable: *cookie* ¶

Package

openai-openapi-client.

Source

main.lisp.

Special Variable: *headers* ¶

Package

openai-openapi-client.

Source

main.lisp.

Special Variable: *parse* ¶

Package

openai-openapi-client.

Source

main.lisp.

Special Variable: *server* ¶

Package

openai-openapi-client.

Source

main.lisp.

---

6.1.2 Ordinary functions

Function: add-upload-part (upload-id &key query headers cookie authorization bearer server parse content) ¶

Operation-id: add-upload-part
Summary: 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).

Package

openai-openapi-client.

Alias for

post/uploads/{upload_id}/parts.

Function: cancel-batch (batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-batch
Summary: 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.

Package

openai-openapi-client.

Alias for

post/batches/{batch_id}/cancel.

Function: cancel-fine-tuning-job (fine-tuning-job-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-fine-tuning-job Summary: Immediately cancel a fine-tune job.

Package

openai-openapi-client.

Alias for

post/fine_tuning/jobs/{fine_tuning_job_id}/cancel.

Function: cancel-run (thread-id run-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-run
Summary: Cancels a run that is ‘in_progress‘.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}/runs/{run_id}/cancel.

Function: cancel-upload (upload-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-upload
Summary: Cancels the Upload. No Parts may be added after an Upload is cancelled.

Package

openai-openapi-client.

Alias for

post/uploads/{upload_id}/cancel.

Function: cancel-vector-store-file-batch (vector-store-id batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-vector-store-file-batch
Summary: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

Package

openai-openapi-client.

Alias for

post/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel.

Function: complete-upload (upload-id &key query headers cookie authorization bearer server parse part-ids md5 content) ¶

Operation-id: complete-upload
Summary: 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.

Package

openai-openapi-client.

Alias for

post/uploads/{upload_id}/complete.

Function: create-assistant (&key query headers cookie authorization bearer server parse model name description instructions tools tool-resources metadata temperature top-p response-format content) ¶

Operation-id: create-assistant
Summary: Create an assistant with a model and instructions.

Package

openai-openapi-client.

Alias for

post/assistants.

Function: create-batch (&key query headers cookie authorization bearer server parse input-file-id endpoint completion-window metadata content) ¶

Operation-id: create-batch
Summary: Creates and executes a batch from an uploaded file of requests

Package

openai-openapi-client.

Alias for

post/batches.

Function: create-chat-completion (&key query headers cookie authorization bearer server parse messages model frequency-penalty logit-bias logprobs top-logprobs max-tokens n presence-penalty response-format seed service-tier stop stream stream-options temperature top-p tools tool-choice parallel-tool-calls user function-call functions content) ¶

Operation-id: create-chat-completion
Summary: Creates a model response for the given chat conversation.

Package

openai-openapi-client.

Alias for

post/chat/completions.

Function: create-completion (&key query headers cookie authorization bearer server parse model prompt best-of echo frequency-penalty logit-bias logprobs max-tokens n presence-penalty seed stop stream stream-options suffix temperature top-p user content) ¶

Operation-id: create-completion
Summary: Creates a completion for the provided prompt and parameters.

Package

openai-openapi-client.

Alias for

post/completions.

Function: create-embedding (&key query headers cookie authorization bearer server parse input model encoding-format dimensions user content) ¶

Operation-id: create-embedding
Summary: Creates an embedding vector representing the input text.

Package

openai-openapi-client.

Alias for

post/embeddings.

Function: create-file (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-file
Summary: 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.

Package

openai-openapi-client.

Alias for

post/files.

Function: create-fine-tuning-job (&key query headers cookie authorization bearer server parse model training-file hyperparameters suffix validation-file integrations seed content) ¶

Operation-id: create-fine-tuning-job
Summary: 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)

Package

openai-openapi-client.

Alias for

post/fine_tuning/jobs.

Function: create-image (&key query headers cookie authorization bearer server parse prompt model n quality response-format size style user content) ¶

Operation-id: create-image
Summary: Creates an image given a prompt.

Package

openai-openapi-client.

Alias for

post/images/generations.

Function: create-image-edit (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-image-edit
Summary: Creates an edited or extended image given an original image and a prompt.

Package

openai-openapi-client.

Alias for

post/images/edits.

Function: create-image-variation (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-image-variation Summary: Creates a variation of a given image.

Package

openai-openapi-client.

Alias for

post/images/variations.

Function: create-message (thread-id &key query headers cookie authorization bearer server parse role attachments metadata content) ¶

Operation-id: create-message Summary: Create a message.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}/messages.

Function: create-moderation (&key query headers cookie authorization bearer server parse input model content) ¶

Operation-id: create-moderation
Summary: Classifies if text is potentially harmful.

Package

openai-openapi-client.

Alias for

post/moderations.

Function: create-run (thread-id &key query headers cookie authorization bearer server parse assistant-id model instructions additional-instructions additional-messages tools metadata temperature top-p stream max-prompt-tokens max-completion-tokens truncation-strategy tool-choice parallel-tool-calls response-format content) ¶

Operation-id: create-run Summary: Create a run.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}/runs.

Function: create-speech (&key query headers cookie authorization bearer server parse model input voice response-format speed content) ¶

Operation-id: create-speech
Summary: Generates audio from the input text.

Package

openai-openapi-client.

Alias for

post/audio/speech.

Function: create-thread (&key query headers cookie authorization bearer server parse messages tool-resources metadata content) ¶

Operation-id: create-thread Summary: Create a thread.

Package

openai-openapi-client.

Alias for

post/threads.

Function: create-thread-and-run (&key query headers cookie authorization bearer server parse assistant-id thread model instructions tools tool-resources metadata temperature top-p stream max-prompt-tokens max-completion-tokens truncation-strategy tool-choice parallel-tool-calls response-format content) ¶

Operation-id: create-thread-and-run
Summary: Create a thread and run it in one request.

Package

openai-openapi-client.

Alias for

post/threads/runs.

Function: create-transcription (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-transcription
Summary: Transcribes audio into the input language.

Package

openai-openapi-client.

Alias for

post/audio/transcriptions.

Function: create-translation (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-translation Summary: Translates audio into English.

Package

openai-openapi-client.

Alias for

post/audio/translations.

Function: create-upload (&key query headers cookie authorization bearer server parse filename purpose bytes mime-type content) ¶

Operation-id: create-upload
Summary: 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).

Package

openai-openapi-client.

Alias for

post/uploads.

Function: create-vector-store (&key query headers cookie authorization bearer server parse file-ids name expires-after chunking-strategy metadata content) ¶

Operation-id: create-vector-store Summary: Create a vector store.

Package

openai-openapi-client.

Alias for

post/vector_stores.

Function: create-vector-store-file (vector-store-id &key query headers cookie authorization bearer server parse file-id chunking-strategy content) ¶

Operation-id: create-vector-store-file
Summary: Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).

Package

openai-openapi-client.

Alias for

post/vector_stores/{vector_store_id}/files.

Function: create-vector-store-file-batch (vector-store-id &key query headers cookie authorization bearer server parse file-ids chunking-strategy content) ¶

Operation-id: create-vector-store-file-batch Summary: Create a vector store file batch.

Package

openai-openapi-client.

Alias for

post/vector_stores/{vector_store_id}/file_batches.

Function: delete-assistant (assistant-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-assistant Summary: Delete an assistant.

Package

openai-openapi-client.

Alias for

delete/assistants/{assistant_id}.

Function: delete-file (file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-file Summary: Delete a file.

Package

openai-openapi-client.

Alias for

delete/files/{file_id}.

Function: delete-message (thread-id message-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-message Summary: Deletes a message.

Package

openai-openapi-client.

Alias for

delete/threads/{thread_id}/messages/{message_id}.

Function: delete-model (model &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-model
Summary: Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.

Package

openai-openapi-client.

Alias for

delete/models/{model}.

Function: delete-thread (thread-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-thread Summary: Delete a thread.

Package

openai-openapi-client.

Alias for

delete/threads/{thread_id}.

Function: delete-vector-store (vector-store-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-vector-store Summary: Delete a vector store.

Package

openai-openapi-client.

Alias for

delete/vector_stores/{vector_store_id}.

Function: delete-vector-store-file (vector-store-id file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-vector-store-file
Summary: 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.

Package

openai-openapi-client.

Alias for

delete/vector_stores/{vector_store_id}/files/{file_id}.

Function: download-file (file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: download-file
Summary: Returns the contents of the specified file.

Package

openai-openapi-client.

Alias for

get/files/{file_id}/content.

Function: get-assistant (assistant-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-assistant Summary: Retrieves an assistant.

Package

openai-openapi-client.

Alias for

get/assistants/{assistant_id}.

Function: get-message (thread-id message-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-message Summary: Retrieve a message.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}/messages/{message_id}.

Function: get-run (thread-id run-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-run Summary: Retrieves a run.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}/runs/{run_id}.

Function: get-run-step (thread-id run-id step-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-run-step Summary: Retrieves a run step.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}/runs/{run_id}/steps/{step_id}.

Function: get-thread (thread-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-thread Summary: Retrieves a thread.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}.

Function: get-vector-store (vector-store-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-vector-store Summary: Retrieves a vector store.

Package

openai-openapi-client.

Alias for

get/vector_stores/{vector_store_id}.

Function: get-vector-store-file (vector-store-id file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-vector-store-file Summary: Retrieves a vector store file.

Package

openai-openapi-client.

Alias for

get/vector_stores/{vector_store_id}/files/{file_id}.

Function: get-vector-store-file-batch (vector-store-id batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-vector-store-file-batch Summary: Retrieves a vector store file batch.

Package

openai-openapi-client.

Alias for

get/vector_stores/{vector_store_id}/file_batches/{batch_id}.

Function: list-assistants (&key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-assistants Summary: Returns a list of assistants.

Package

openai-openapi-client.

Alias for

get/assistants.

Function: list-batches (&key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-batches
Summary: List your organization’s batches.

Package

openai-openapi-client.

Alias for

get/batches.

Function: list-files (&key query headers cookie authorization bearer server parse purpose) ¶

Operation-id: list-files
Summary: Returns a list of files that belong to the user’s organization.

Package

openai-openapi-client.

Alias for

get/files.

Function: list-files-in-vector-store-batch (vector-store-id batch-id &key query headers cookie authorization bearer server parse limit order after before filter) ¶

Operation-id: list-files-in-vector-store-batch Summary: Returns a list of vector store files in a batch.

Package

openai-openapi-client.

Alias for

get/vector_stores/{vector_store_id}/file_batches/{batch_id}/files.

Function: list-fine-tuning-events (fine-tuning-job-id &key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-fine-tuning-events
Summary: Get status updates for a fine-tuning job.

Package

openai-openapi-client.

Alias for

get/fine_tuning/jobs/{fine_tuning_job_id}/events.

Function: list-fine-tuning-job-checkpoints (fine-tuning-job-id &key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-fine-tuning-job-checkpoints Summary: List checkpoints for a fine-tuning job.

Package

openai-openapi-client.

Alias for

get/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints.

Function: list-messages (thread-id &key query headers cookie authorization bearer server parse limit order after before run-id) ¶

Operation-id: list-messages
Summary: Returns a list of messages for a given thread.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}/messages.

Function: list-models (&key query headers cookie authorization bearer server parse) ¶

Operation-id: list-models
Summary: Lists the currently available models, and provides basic information about each one such as the owner and availability.

Package

openai-openapi-client.

Alias for

get/models.

Function: list-paginated-fine-tuning-jobs (&key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-paginated-fine-tuning-jobs Summary: List your organization’s fine-tuning jobs

Package

openai-openapi-client.

Alias for

get/fine_tuning/jobs.

Function: list-run-steps (thread-id run-id &key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-run-steps
Summary: Returns a list of run steps belonging to a run.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}/runs/{run_id}/steps.

Function: list-runs (thread-id &key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-runs
Summary: Returns a list of runs belonging to a thread.

Package

openai-openapi-client.

Alias for

get/threads/{thread_id}/runs.

Function: list-vector-store-files (vector-store-id &key query headers cookie authorization bearer server parse limit order after before filter) ¶

Operation-id: list-vector-store-files Summary: Returns a list of vector store files.

Package

openai-openapi-client.

Alias for

get/vector_stores/{vector_store_id}/files.

Function: list-vector-stores (&key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-vector-stores Summary: Returns a list of vector stores.

Package

openai-openapi-client.

Alias for

get/vector_stores.

Function: modify-assistant (assistant-id &key query headers cookie authorization bearer server parse model name description instructions tools tool-resources metadata temperature top-p response-format content) ¶

Operation-id: modify-assistant Summary: Modifies an assistant.

Package

openai-openapi-client.

Alias for

post/assistants/{assistant_id}.

Function: modify-message (thread-id message-id &key query headers cookie authorization bearer server parse metadata content) ¶

Operation-id: modify-message Summary: Modifies a message.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}/messages/{message_id}.

Function: modify-run (thread-id run-id &key query headers cookie authorization bearer server parse metadata content) ¶

Operation-id: modify-run Summary: Modifies a run.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}/runs/{run_id}.

Function: modify-thread (thread-id &key query headers cookie authorization bearer server parse tool-resources metadata content) ¶

Operation-id: modify-thread Summary: Modifies a thread.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}.

Function: modify-vector-store (vector-store-id &key query headers cookie authorization bearer server parse name expires-after metadata content) ¶

Operation-id: modify-vector-store Summary: Modifies a vector store.

Package

openai-openapi-client.

Alias for

post/vector_stores/{vector_store_id}.

Function: retrieve-batch (batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-batch Summary: Retrieves a batch.

Package

openai-openapi-client.

Alias for

get/batches/{batch_id}.

Function: retrieve-file (file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-file
Summary: Returns information about a specific file.

Package

openai-openapi-client.

Alias for

get/files/{file_id}.

Function: retrieve-fine-tuning-job (fine-tuning-job-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-fine-tuning-job
Summary: Get info about a fine-tuning job.

[Learn more about fine-tuning](/docs/guides/fine-tuning)

Package

openai-openapi-client.

Alias for

get/fine_tuning/jobs/{fine_tuning_job_id}.

Function: retrieve-model (model &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-model
Summary: Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

Package

openai-openapi-client.

Alias for

get/models/{model}.

Function: submit-tool-ouputs-to-run (thread-id run-id &key query headers cookie authorization bearer server parse tool-outputs stream content) ¶

Operation-id: submit-tool-ouputs-to-run
Summary: 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.

Package

openai-openapi-client.

Alias for

post/threads/{thread_id}/runs/{run_id}/submit_tool_outputs.

---

6.2.1 Special variables

Special Variable: *query* ¶

Package

openai-openapi-client.

Source

main.lisp.

---

6.2.2 Ordinary functions

Function: delete/assistants/{assistant_id} (assistant-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-assistant Summary: Delete an assistant.

Package

openai-openapi-client.

Source

main.lisp.

Function: delete/files/{file_id} (file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-file Summary: Delete a file.

Package

openai-openapi-client.

Source

main.lisp.

Function: delete/models/{model} (model &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-model
Summary: Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.

Package

openai-openapi-client.

Source

main.lisp.

Function: delete/threads/{thread_id} (thread-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-thread Summary: Delete a thread.

Package

openai-openapi-client.

Source

main.lisp.

Function: delete/threads/{thread_id}/messages/{message_id} (thread-id message-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-message Summary: Deletes a message.

Package

openai-openapi-client.

Source

main.lisp.

Function: delete/vector_stores/{vector_store_id} (vector-store-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-vector-store Summary: Delete a vector store.

Package

openai-openapi-client.

Source

main.lisp.

Function: delete/vector_stores/{vector_store_id}/files/{file_id} (vector-store-id file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: delete-vector-store-file
Summary: 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.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/assistants (&key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-assistants Summary: Returns a list of assistants.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/assistants/{assistant_id} (assistant-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-assistant Summary: Retrieves an assistant.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/batches (&key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-batches
Summary: List your organization’s batches.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/batches/{batch_id} (batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-batch Summary: Retrieves a batch.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/files (&key query headers cookie authorization bearer server parse purpose) ¶

Operation-id: list-files
Summary: Returns a list of files that belong to the user’s organization.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/files/{file_id} (file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-file
Summary: Returns information about a specific file.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/files/{file_id}/content (file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: download-file
Summary: Returns the contents of the specified file.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/fine_tuning/jobs (&key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-paginated-fine-tuning-jobs Summary: List your organization’s fine-tuning jobs

Package

openai-openapi-client.

Source

main.lisp.

Function: get/fine_tuning/jobs/{fine_tuning_job_id} (fine-tuning-job-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-fine-tuning-job
Summary: Get info about a fine-tuning job.

[Learn more about fine-tuning](/docs/guides/fine-tuning)

Package

openai-openapi-client.

Source

main.lisp.

Function: get/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints (fine-tuning-job-id &key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-fine-tuning-job-checkpoints Summary: List checkpoints for a fine-tuning job.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/fine_tuning/jobs/{fine_tuning_job_id}/events (fine-tuning-job-id &key query headers cookie authorization bearer server parse after limit) ¶

Operation-id: list-fine-tuning-events
Summary: Get status updates for a fine-tuning job.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/models (&key query headers cookie authorization bearer server parse) ¶

Operation-id: list-models
Summary: Lists the currently available models, and provides basic information about each one such as the owner and availability.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/models/{model} (model &key query headers cookie authorization bearer server parse) ¶

Operation-id: retrieve-model
Summary: Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id} (thread-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-thread Summary: Retrieves a thread.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id}/messages (thread-id &key query headers cookie authorization bearer server parse limit order after before run-id) ¶

Operation-id: list-messages
Summary: Returns a list of messages for a given thread.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id}/messages/{message_id} (thread-id message-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-message Summary: Retrieve a message.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id}/runs (thread-id &key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-runs
Summary: Returns a list of runs belonging to a thread.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id}/runs/{run_id} (thread-id run-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-run Summary: Retrieves a run.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id}/runs/{run_id}/steps (thread-id run-id &key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-run-steps
Summary: Returns a list of run steps belonging to a run.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/threads/{thread_id}/runs/{run_id}/steps/{step_id} (thread-id run-id step-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-run-step Summary: Retrieves a run step.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/vector_stores (&key query headers cookie authorization bearer server parse limit order after before) ¶

Operation-id: list-vector-stores Summary: Returns a list of vector stores.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/vector_stores/{vector_store_id} (vector-store-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-vector-store Summary: Retrieves a vector store.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/vector_stores/{vector_store_id}/file_batches/{batch_id} (vector-store-id batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-vector-store-file-batch Summary: Retrieves a vector store file batch.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/vector_stores/{vector_store_id}/file_batches/{batch_id}/files (vector-store-id batch-id &key query headers cookie authorization bearer server parse limit order after before filter) ¶

Operation-id: list-files-in-vector-store-batch Summary: Returns a list of vector store files in a batch.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/vector_stores/{vector_store_id}/files (vector-store-id &key query headers cookie authorization bearer server parse limit order after before filter) ¶

Operation-id: list-vector-store-files Summary: Returns a list of vector store files.

Package

openai-openapi-client.

Source

main.lisp.

Function: get/vector_stores/{vector_store_id}/files/{file_id} (vector-store-id file-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: get-vector-store-file Summary: Retrieves a vector store file.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/assistants (&key query headers cookie authorization bearer server parse model name description instructions tools tool-resources metadata temperature top-p response-format content) ¶

Operation-id: create-assistant
Summary: Create an assistant with a model and instructions.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/assistants/{assistant_id} (assistant-id &key query headers cookie authorization bearer server parse model name description instructions tools tool-resources metadata temperature top-p response-format content) ¶

Operation-id: modify-assistant Summary: Modifies an assistant.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/audio/speech (&key query headers cookie authorization bearer server parse model input voice response-format speed content) ¶

Operation-id: create-speech
Summary: Generates audio from the input text.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/audio/transcriptions (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-transcription
Summary: Transcribes audio into the input language.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/audio/translations (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-translation Summary: Translates audio into English.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/batches (&key query headers cookie authorization bearer server parse input-file-id endpoint completion-window metadata content) ¶

Operation-id: create-batch
Summary: Creates and executes a batch from an uploaded file of requests

Package

openai-openapi-client.

Source

main.lisp.

Function: post/batches/{batch_id}/cancel (batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-batch
Summary: 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.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/chat/completions (&key query headers cookie authorization bearer server parse messages model frequency-penalty logit-bias logprobs top-logprobs max-tokens n presence-penalty response-format seed service-tier stop stream stream-options temperature top-p tools tool-choice parallel-tool-calls user function-call functions content) ¶

Operation-id: create-chat-completion
Summary: Creates a model response for the given chat conversation.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/completions (&key query headers cookie authorization bearer server parse model prompt best-of echo frequency-penalty logit-bias logprobs max-tokens n presence-penalty seed stop stream stream-options suffix temperature top-p user content) ¶

Operation-id: create-completion
Summary: Creates a completion for the provided prompt and parameters.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/embeddings (&key query headers cookie authorization bearer server parse input model encoding-format dimensions user content) ¶

Operation-id: create-embedding
Summary: Creates an embedding vector representing the input text.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/files (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-file
Summary: 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.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/fine_tuning/jobs (&key query headers cookie authorization bearer server parse model training-file hyperparameters suffix validation-file integrations seed content) ¶

Operation-id: create-fine-tuning-job
Summary: 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)

Package

openai-openapi-client.

Source

main.lisp.

Function: post/fine_tuning/jobs/{fine_tuning_job_id}/cancel (fine-tuning-job-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-fine-tuning-job Summary: Immediately cancel a fine-tune job.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/images/edits (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-image-edit
Summary: Creates an edited or extended image given an original image and a prompt.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/images/generations (&key query headers cookie authorization bearer server parse prompt model n quality response-format size style user content) ¶

Operation-id: create-image
Summary: Creates an image given a prompt.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/images/variations (&key query headers cookie authorization bearer server parse content) ¶

Operation-id: create-image-variation Summary: Creates a variation of a given image.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/moderations (&key query headers cookie authorization bearer server parse input model content) ¶

Operation-id: create-moderation
Summary: Classifies if text is potentially harmful.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads (&key query headers cookie authorization bearer server parse messages tool-resources metadata content) ¶

Operation-id: create-thread Summary: Create a thread.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/runs (&key query headers cookie authorization bearer server parse assistant-id thread model instructions tools tool-resources metadata temperature top-p stream max-prompt-tokens max-completion-tokens truncation-strategy tool-choice parallel-tool-calls response-format content) ¶

Operation-id: create-thread-and-run
Summary: Create a thread and run it in one request.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id} (thread-id &key query headers cookie authorization bearer server parse tool-resources metadata content) ¶

Operation-id: modify-thread Summary: Modifies a thread.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id}/messages (thread-id &key query headers cookie authorization bearer server parse role attachments metadata content) ¶

Operation-id: create-message Summary: Create a message.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id}/messages/{message_id} (thread-id message-id &key query headers cookie authorization bearer server parse metadata content) ¶

Operation-id: modify-message Summary: Modifies a message.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id}/runs (thread-id &key query headers cookie authorization bearer server parse assistant-id model instructions additional-instructions additional-messages tools metadata temperature top-p stream max-prompt-tokens max-completion-tokens truncation-strategy tool-choice parallel-tool-calls response-format content) ¶

Operation-id: create-run Summary: Create a run.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id}/runs/{run_id} (thread-id run-id &key query headers cookie authorization bearer server parse metadata content) ¶

Operation-id: modify-run Summary: Modifies a run.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id}/runs/{run_id}/cancel (thread-id run-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-run
Summary: Cancels a run that is ‘in_progress‘.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/threads/{thread_id}/runs/{run_id}/submit_tool_outputs (thread-id run-id &key query headers cookie authorization bearer server parse tool-outputs stream content) ¶

Operation-id: submit-tool-ouputs-to-run
Summary: 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.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/uploads (&key query headers cookie authorization bearer server parse filename purpose bytes mime-type content) ¶

Operation-id: create-upload
Summary: 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).

Package

openai-openapi-client.

Source

main.lisp.

Function: post/uploads/{upload_id}/cancel (upload-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-upload
Summary: Cancels the Upload. No Parts may be added after an Upload is cancelled.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/uploads/{upload_id}/complete (upload-id &key query headers cookie authorization bearer server parse part-ids md5 content) ¶

Operation-id: complete-upload
Summary: 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.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/uploads/{upload_id}/parts (upload-id &key query headers cookie authorization bearer server parse content) ¶

Operation-id: add-upload-part
Summary: 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).

Package

openai-openapi-client.

Source

main.lisp.

Function: post/vector_stores (&key query headers cookie authorization bearer server parse file-ids name expires-after chunking-strategy metadata content) ¶

Operation-id: create-vector-store Summary: Create a vector store.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/vector_stores/{vector_store_id} (vector-store-id &key query headers cookie authorization bearer server parse name expires-after metadata content) ¶

Operation-id: modify-vector-store Summary: Modifies a vector store.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/vector_stores/{vector_store_id}/file_batches (vector-store-id &key query headers cookie authorization bearer server parse file-ids chunking-strategy content) ¶

Operation-id: create-vector-store-file-batch Summary: Create a vector store file batch.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel (vector-store-id batch-id &key query headers cookie authorization bearer server parse) ¶

Operation-id: cancel-vector-store-file-batch
Summary: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

Package

openai-openapi-client.

Source

main.lisp.

Function: post/vector_stores/{vector_store_id}/files (vector-store-id &key query headers cookie authorization bearer server parse file-id chunking-strategy content) ¶

Operation-id: create-vector-store-file
Summary: Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).

Package

openai-openapi-client.

Source

main.lisp.

---