Jump to Content
Docs
API Reference
Legal Clauses
Docs
API Reference
Login
API Reference
Docs
API Reference
Login
Docs
API Reference
Legal Clauses
Returns a list of files.
Search
All
Pages
Start typing to search…
JUMP TO
Hispread API
Assistants
Returns a list of assistants.
get
Create an assistant with a model and instructions.
post
Retrieves an assistant.
get
Modifies an assistant.
post
Delete an assistant.
delete
Create a thread.
post
Create a thread and run it in one request.
post
Retrieves a thread.
get
Modifies a thread.
post
Delete a thread.
delete
Returns a list of messages for a given thread.
get
Create a message.
post
Retrieve a message.
get
Modifies a message.
post
Deletes a message.
delete
Returns a list of runs belonging to a thread.
get
Create a run.
post
Retrieves a run.
get
Modifies a run.
post
Cancels a run that is `in_progress`.
post
Returns a list of run steps belonging to a run.
get
Retrieves a run step.
get
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.
post
Batch
Creates and executes a batch from an uploaded file of requests
post
List your organization's batches.
get
Retrieves a batch.
get
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.
post
Chat
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. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, [refer to the reasoning guide](/docs/guides/reasoning).
post
Completions
Creates a completion for the provided prompt and parameters.
post
Embeddings
Creates an embedding vector representing the input text.
post
Files
Returns a list of files.
get
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 200 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.
post
Delete a file.
delete
Returns information about a specific file.
get
Returns the contents of the specified file.
get
Fine-tuning
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)
post
List your organization's fine-tuning jobs
get
Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/fine-tuning)
get
Immediately cancel a fine-tune job.
post
List checkpoints for a fine-tuning job.
get
Get status updates for a fine-tuning job.
get
Models
Lists the currently available models, and provides basic information about each one such as the owner and availability.
get
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
get
Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
delete
Moderations
Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation).
post
Usage
Get costs details for the organization.
get
Get audio speeches usage details for the organization.
get
Get audio transcriptions usage details for the organization.
get
Get code interpreter sessions usage details for the organization.
get
Get completions usage details for the organization.
get
Get embeddings usage details for the organization.
get
Get images usage details for the organization.
get
Get moderations usage details for the organization.
get
Get vector stores usage details for the organization.
get
Realtime
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. It responds with a session object, plus a `client_secret` key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.
post
Uploads
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).
post
Cancels the Upload. No Parts may be added after an Upload is cancelled.
post
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.
post
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).
post
Powered by
Returns a list of files.
get
https://api.myhispread.com/v1/files
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!
