vector_store_idstringrequired
The ID of the vector store that the file belongs to.
file_idstringrequired
The ID of the file to delete.
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.
delete
https://api.openai.com/v1/vector_stores/{vector_store_id}/files/{file_id}
Path Parameters
Response
200 application/json
Response
200 application/json
OK
DeleteVectorStoreFileResponse
idstringrequired
deletedbooleanrequired
objectstringrequired
Allowed values:vector_store.file.deleted
delete/vector_stores/{vector_store_id}/files/{file_id}
Authentication
Path Parameters
200 application/json
AddUploadPartRequest
object * Additional properties are NOT allowed.
datastring(binary)required
The chunk of bytes for this Part.
Example
AdminApiKey
objectobjectstring
Example:organization.admin_api_key
idstring
Example:key_abc
namestring
Example:Administration Key
redacted_valuestring
Example:sk-admin...def
valuestring
Example:sk-admin-1234abcd
created_atinteger(int64)
Example:1711471533
ownerobject
Show Child Parameters
Example
ApiKeyList
objectobjectstring
Example:list
dataarray[object]
Show Child Parameters
has_moreboolean
first_idstring
Example:key_abc
last_idstring
Example:key_xyz
Example
Assistant
objectRepresents an assistant that can call the model and use tools.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always assistant.
Allowed values:assistant
created_atintegerrequired
The Unix timestamp (in seconds) for when the assistant was created.
namestringrequired
The name of the assistant. The maximum length is 256 characters.
<= 256 characters
descriptionstringrequired
The description of the assistant. The maximum length is 512 characters.
<= 512 characters
modelstringrequired
ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
instructionsstringrequired
The system instructions that the assistant uses. The maximum length is 256,000 characters.
<= 256000 characters
tools
One Ofarrayrequired
A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.
Default:[]
<= 128 items
Code interpreter toolobject
Show Child Parameters
tool_resourcesobject
A set of resources that are used by the assistant’s tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.
Show Child Parameters
metadataobjectrequired
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
temperaturenumber
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
Default:1
>= 0<= 2
Example:1
top_pnumber
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or temperature but not both.
Default:1
>= 0<= 1
Example:1
response_format
One OfAssistantsApiResponseFormatOptionstring
auto is the default value
Allowed values:auto
Example