Azure OpenAI (preview:2025-01-01)

2025/02/20 • 40 new methods

ListAssistants (new)
Description :  Gets a list of assistants that were previously created.
Reference :  Link ¶

⚼ Request

GET:  /assistants
{
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always assistant. ,
Enum:
{
assistant: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the assistant. ,
Required: True ,
}
string ,
description:
{
Description: The description of the assistant. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the assistant to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the assistant. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: 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. ,
Required: True ,
}
object ,
temperature:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
CreateAssistant (new)
Description :  Creates a new assistant.
Reference :  Link ¶

⚼ Request

POST:  /assistants
{
body:
{
Description: The request details to use when creating a new assistant. ,
Required: True ,
}
{
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
name:
{
Description: The name of the new assistant. ,
Required: False ,
}
string ,
description:
{
Description: The description of the new assistant. ,
Required: False ,
}
string ,
instructions:
{
Description: The system instructions for the new assistant to use. ,
Required: False ,
}
string ,
tools:
{
Description: The collection of tools to enable for the new assistant. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: 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. ,
Required: False ,
}
object ,
temperature:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always assistant. ,
Enum:
{
assistant: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the assistant. ,
Required: True ,
}
string ,
description:
{
Description: The description of the assistant. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the assistant to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the assistant. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: 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. ,
Required: True ,
}
object ,
temperature:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
GetAssistant (new)
Description :  Retrieves an existing assistant.
Reference :  Link ¶

⚼ Request

GET:  /assistants/{assistantId}
{
assistantId:
{
Description: The ID of the assistant to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always assistant. ,
Enum:
{
assistant: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the assistant. ,
Required: True ,
}
string ,
description:
{
Description: The description of the assistant. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the assistant to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the assistant. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: 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. ,
Required: True ,
}
object ,
temperature:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
UpdateAssistant (new)
Description :  Modifies an existing assistant.
Reference :  Link ¶

⚼ Request

POST:  /assistants/{assistantId}
{
assistantId:
{
Description: The ID of the assistant to modify. ,
Required: True ,
}
string ,
body:
{
Description: The request details to use when modifying an existing assistant. ,
Required: True ,
}
{
model:
{
Description: The ID of the model to use. ,
Required: False ,
}
string ,
name:
{
Description: The modified name for the assistant to use. ,
Required: False ,
}
string ,
description:
{
Description: The modified description for the assistant to use. ,
Required: False ,
}
string ,
instructions:
{
Description: The modified system instructions for the new assistant to use. ,
Required: False ,
}
string ,
tools:
{
Description: The modified collection of tools to enable for the assistant. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: 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. ,
Required: False ,
}
{
code_interpreter:
{
Description: Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. ,
Required: False ,
}
{
file_ids:
{
Description: A list of file IDs to override the current list of the assistant. ,
Required: False ,
}
[
string ,
]
,
}
,
file_search:
{
Description: Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. ,
Required: False ,
}
{
vector_store_ids:
{
Description: A list of vector store IDs to override the current list of the assistant. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
temperature:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always assistant. ,
Enum:
{
assistant: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the assistant. ,
Required: True ,
}
string ,
description:
{
Description: The description of the assistant. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the assistant to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the assistant. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: 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. ,
Required: True ,
}
object ,
temperature:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: True ,
}
number ,
response_format:
{
Description: The response format of the tool calls used by this assistant. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
DeleteAssistant (new)
Description :  Deletes an assistant.
Reference :  Link ¶

⚼ Request

DELETE:  /assistants/{assistantId}
{
assistantId:
{
Description: The ID of the assistant to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource specified for deletion. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether deletion was successful. ,
Required: True ,
}
boolean ,
object:
{
Description: The object type, which is always 'assistant.deleted'. ,
Enum:
{
assistant.deleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
ListFiles (new)
Description :  Gets a list of previously uploaded files.
Reference :  Link ¶

⚼ Request

GET:  /files
{
purpose:
{
Description: A value that, when provided, limits list results to files matching the corresponding purpose. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always 'list'. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The files returned for the request. ,
Required: True ,
}
[
{
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
bytes:
{
Description: The size of the file, in bytes. ,
Format: int32 ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of a file. ,
Enum:
{
fine-tune: Indicates a file is used for fine tuning input. ,
fine-tune-results: Indicates a file is used for fine tuning results. ,
assistants: Indicates a file is used as input to assistants. ,
assistants_output: Indicates a file is used as output by assistants. ,
batch: Indicates a file is used as input to . ,
batch_output: Indicates a file is used as output by a vector store batch operation. ,
vision: Indicates a file is used as input to a vision operation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The state of the file. This field is available in Azure OpenAI only. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
status_details:
{
Description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. ,
Required: False ,
}
string ,
}
,
]
,
}
UploadFile (new)
Description :  Uploads a file for use by other operations.
Reference :  Link ¶

⚼ Request

POST:  /files
{
file:
{
Description: The file data (not filename) to upload. ,
Required: True ,
}
file ,
purpose:
{
Description: The intended purpose of the file. ,
Required: True ,
}
string ,
filename:
{
Description: A filename to associate with the uploaded data. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
bytes:
{
Description: The size of the file, in bytes. ,
Format: int32 ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of a file. ,
Enum:
{
fine-tune: Indicates a file is used for fine tuning input. ,
fine-tune-results: Indicates a file is used for fine tuning results. ,
assistants: Indicates a file is used as input to assistants. ,
assistants_output: Indicates a file is used as output by assistants. ,
batch: Indicates a file is used as input to . ,
batch_output: Indicates a file is used as output by a vector store batch operation. ,
vision: Indicates a file is used as input to a vision operation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The state of the file. This field is available in Azure OpenAI only. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
status_details:
{
Description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. ,
Required: False ,
}
string ,
}
GetFile (new)
Description :  Returns information about a specific file. Does not retrieve file content.
Reference :  Link ¶

⚼ Request

GET:  /files/{fileId}
{
fileId:
{
Description: The ID of the file to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
bytes:
{
Description: The size of the file, in bytes. ,
Format: int32 ,
Required: True ,
}
integer ,
filename:
{
Description: The name of the file. ,
Required: True ,
}
string ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
purpose:
{
Description: The intended purpose of a file. ,
Enum:
{
fine-tune: Indicates a file is used for fine tuning input. ,
fine-tune-results: Indicates a file is used for fine tuning results. ,
assistants: Indicates a file is used as input to assistants. ,
assistants_output: Indicates a file is used as output by assistants. ,
batch: Indicates a file is used as input to . ,
batch_output: Indicates a file is used as output by a vector store batch operation. ,
vision: Indicates a file is used as input to a vision operation. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The state of the file. This field is available in Azure OpenAI only. ,
Enum:
{
uploaded: The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. ,
pending: The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state. ,
running: The operation has started to be processed. It can be categorized as an active state. ,
processed: The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state. ,
error: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. ,
deleting: The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state. ,
deleted: The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state. ,
}
,
Required: False ,
}
enum ,
status_details:
{
Description: The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. ,
Required: False ,
}
string ,
}
DeleteFile (new)
Description :  Delete a previously uploaded file.
Reference :  Link ¶

⚼ Request

DELETE:  /files/{fileId}
{
fileId:
{
Description: The ID of the file to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource specified for deletion. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether deletion was successful. ,
Required: True ,
}
boolean ,
object:
{
Description: The object type, which is always 'file'. ,
Enum:
{
file: No description available. ,
}
,
Required: True ,
}
enum ,
}
GetFileContent (new)
Description :  Returns information about a specific file. Does not retrieve file content.
Reference :  Link ¶

⚼ Request

GET:  /files/{fileId}/content
{
fileId:
{
Description: The ID of the file to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: byte ,
}
string ,
}
CreateThread (new)
Description :  Creates a new thread. Threads contain messages and can be run by assistants.
Reference :  Link ¶

⚼ Request

POST:  /threads
{
body:
{
Description: The details used to create a new assistant thread. ,
Required: True ,
}
{
messages:
{
Description: The initial messages to associate with the new thread. ,
Required: False ,
}
[
{
role:
{
Description: The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they should be added to. ,
Required: False ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are made available to the assistant's tools in this thread. 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. ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread'. ,
Enum:
{
thread: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
tool_resources:
{
Description: A set of resources that are made available to the assistant's tools in this thread. 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. ,
Required: True ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
GetThread (new)
Description :  Gets information about an existing thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}
{
threadId:
{
Description: The ID of the thread to retrieve information about. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread'. ,
Enum:
{
thread: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
tool_resources:
{
Description: A set of resources that are made available to the assistant's tools in this thread. 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. ,
Required: True ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
UpdateThread (new)
Description :  Modifies an existing thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}
{
threadId:
{
Description: The ID of the thread to modify. ,
Required: True ,
}
string ,
body:
{
Description: The details used to update an existing assistant thread. ,
Required: True ,
}
{
tool_resources:
{
Description: A set of resources that are made available to the assistant's tools in this thread. 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 ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread'. ,
Enum:
{
thread: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
tool_resources:
{
Description: A set of resources that are made available to the assistant's tools in this thread. 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. ,
Required: True ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
DeleteThread (new)
Description :  Deletes an existing thread.
Reference :  Link ¶

⚼ Request

DELETE:  /threads/{threadId}
{
threadId:
{
Description: The ID of the thread to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource specified for deletion. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether deletion was successful. ,
Required: True ,
}
boolean ,
object:
{
Description: The object type, which is always 'thread.deleted'. ,
Enum:
{
thread.deleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
ListMessages (new)
Description :  Gets a list of messages that exist on a thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/messages
{
threadId:
{
Description: The ID of the thread to list messages from. ,
Required: True ,
}
string ,
runId:
{
Description: Filter messages by the run ID that generated them. ,
Required: False ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.message'. ,
Enum:
{
thread.message: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
thread_id:
{
Description: The ID of the thread that this message belongs to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the message. ,
Enum:
{
in_progress: A run is currently creating this message. ,
incomplete: This message is incomplete. See incomplete_details for more information. ,
completed: This message was successfully completed by a run. ,
}
,
Required: True ,
}
enum ,
incomplete_details:
{
Description: On an incomplete message, details about why the message is incomplete. ,
Required: True ,
}
object ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the message was completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_at:
{
Description: The Unix timestamp (in seconds) for when the message was marked as incomplete. ,
Format: unixtime ,
Required: True ,
}
integer ,
role:
{
Description: The role associated with the assistant thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the assistant thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the assistant that authored this message. ,
Required: True ,
}
string ,
run_id:
{
Description: If applicable, the ID of the run associated with the authoring of this message. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they were added to. ,
Required: True ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
CreateMessage (new)
Description :  Creates a new message on a specified thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/messages
{
threadId:
{
Description: The ID of the thread to create the new message on. ,
Required: True ,
}
string ,
body:
{
Description: A single message within an assistant thread, as provided during that thread's creation for its initial state. ,
Required: True ,
}
{
role:
{
Description: The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they should be added to. ,
Required: False ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.message'. ,
Enum:
{
thread.message: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
thread_id:
{
Description: The ID of the thread that this message belongs to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the message. ,
Enum:
{
in_progress: A run is currently creating this message. ,
incomplete: This message is incomplete. See incomplete_details for more information. ,
completed: This message was successfully completed by a run. ,
}
,
Required: True ,
}
enum ,
incomplete_details:
{
Description: On an incomplete message, details about why the message is incomplete. ,
Required: True ,
}
object ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the message was completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_at:
{
Description: The Unix timestamp (in seconds) for when the message was marked as incomplete. ,
Format: unixtime ,
Required: True ,
}
integer ,
role:
{
Description: The role associated with the assistant thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the assistant thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the assistant that authored this message. ,
Required: True ,
}
string ,
run_id:
{
Description: If applicable, the ID of the run associated with the authoring of this message. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they were added to. ,
Required: True ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
GetMessage (new)
Description :  Gets an existing message from an existing thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/messages/{messageId}
{
threadId:
{
Description: The ID of the thread to retrieve the specified message from. ,
Required: True ,
}
string ,
messageId:
{
Description: The ID of the message to retrieve from the specified thread. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.message'. ,
Enum:
{
thread.message: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
thread_id:
{
Description: The ID of the thread that this message belongs to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the message. ,
Enum:
{
in_progress: A run is currently creating this message. ,
incomplete: This message is incomplete. See incomplete_details for more information. ,
completed: This message was successfully completed by a run. ,
}
,
Required: True ,
}
enum ,
incomplete_details:
{
Description: On an incomplete message, details about why the message is incomplete. ,
Required: True ,
}
object ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the message was completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_at:
{
Description: The Unix timestamp (in seconds) for when the message was marked as incomplete. ,
Format: unixtime ,
Required: True ,
}
integer ,
role:
{
Description: The role associated with the assistant thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the assistant thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the assistant that authored this message. ,
Required: True ,
}
string ,
run_id:
{
Description: If applicable, the ID of the run associated with the authoring of this message. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they were added to. ,
Required: True ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
UpdateMessage (new)
Description :  Modifies an existing message on an existing thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/messages/{messageId}
{
threadId:
{
Description: The ID of the thread containing the specified message to modify. ,
Required: True ,
}
string ,
messageId:
{
Description: The ID of the message to modify on the specified thread. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.message'. ,
Enum:
{
thread.message: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
thread_id:
{
Description: The ID of the thread that this message belongs to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the message. ,
Enum:
{
in_progress: A run is currently creating this message. ,
incomplete: This message is incomplete. See incomplete_details for more information. ,
completed: This message was successfully completed by a run. ,
}
,
Required: True ,
}
enum ,
incomplete_details:
{
Description: On an incomplete message, details about why the message is incomplete. ,
Required: True ,
}
object ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the message was completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_at:
{
Description: The Unix timestamp (in seconds) for when the message was marked as incomplete. ,
Format: unixtime ,
Required: True ,
}
integer ,
role:
{
Description: The role associated with the assistant thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the assistant thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the assistant that authored this message. ,
Required: True ,
}
string ,
run_id:
{
Description: If applicable, the ID of the run associated with the authoring of this message. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they were added to. ,
Required: True ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
ListRuns (new)
Description :  Gets a list of runs for a specified thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs
{
threadId:
{
Description: The ID of the thread to list runs from. ,
Required: True ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
CreateRun (new)
Description :  Creates a new run for an assistant thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs
{
threadId:
{
Description: The ID of the thread to run. ,
Required: True ,
}
string ,
include[]:
{
Description: A list of additional fields to include in the response. ,
Required: False ,
}
array ,
body:
{
Description: The details used when creating a new run of an assistant thread. ,
Required: True ,
}
{
assistant_id:
{
Description: The ID of the assistant that should run the thread. ,
Required: True ,
}
string ,
model:
{
Description: The overridden model name that the assistant should use to run the thread. ,
Required: False ,
}
string ,
instructions:
{
Description: The overridden system instructions that the assistant should use to run the thread. ,
Required: False ,
}
string ,
additional_instructions:
{
Description: Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. ,
Required: False ,
}
string ,
additional_messages:
{
Description: Adds additional messages to the thread before creating the run. ,
Required: False ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.message'. ,
Enum:
{
thread.message: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
thread_id:
{
Description: The ID of the thread that this message belongs to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the message. ,
Enum:
{
in_progress: A run is currently creating this message. ,
incomplete: This message is incomplete. See incomplete_details for more information. ,
completed: This message was successfully completed by a run. ,
}
,
Required: True ,
}
enum ,
incomplete_details:
{
Description: On an incomplete message, details about why the message is incomplete. ,
Required: True ,
}
object ,
completed_at:
{
Description: The Unix timestamp (in seconds) for when the message was completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_at:
{
Description: The Unix timestamp (in seconds) for when the message was marked as incomplete. ,
Format: unixtime ,
Required: True ,
}
integer ,
role:
{
Description: The role associated with the assistant thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the assistant thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the assistant that authored this message. ,
Required: True ,
}
string ,
run_id:
{
Description: If applicable, the ID of the run associated with the authoring of this message. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they were added to. ,
Required: True ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
tools:
{
Description: The overridden list of enabled tools that the assistant should use to run the thread. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: False ,
}
boolean ,
stream:
{
Description: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. ,
Required: False ,
}
boolean ,
temperature:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. ,
Format: int32 ,
Required: False ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. ,
Format: int32 ,
Required: False ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: False ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: False ,
}
string ,
response_format:
{
Description: Specifies the format that the model must output. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
GetRun (new)
Description :  Gets an existing run from an existing thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs/{runId}
{
threadId:
{
Description: The ID of the thread to retrieve run information from. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the thread to retrieve information about. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
UpdateRun (new)
Description :  Modifies an existing thread run.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs/{runId}
{
threadId:
{
Description: The ID of the thread associated with the specified run. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the run to modify. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
CancelRun (new)
Description :  Cancels a run of an in progress thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs/{runId}/cancel
{
threadId:
{
Description: The ID of the thread being run. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the run to cancel. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
ListRunSteps (new)
Description :  Gets a list of run steps from a thread run.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs/{runId}/steps
{
threadId:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the run to list steps from. ,
Required: True ,
}
string ,
include[]:
{
Description: A list of additional fields to include in the response. ,
Required: False ,
}
array ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run.step'. ,
Enum:
{
thread.run.step: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: The type of run step, which can be either message_creation or tool_calls. ,
Enum:
{
message_creation: Represents a run step to create a message. ,
tool_calls: Represents a run step that calls tools. ,
}
,
Required: True ,
}
enum ,
assistant_id:
{
Description: The ID of the assistant associated with the run step. ,
Required: True ,
}
string ,
thread_id:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
run_id:
{
Description: The ID of the run that this run step is a part of. ,
Required: True ,
}
string ,
status:
{
Description: The status of this run step. ,
Enum:
{
in_progress: Represents a run step still in progress. ,
cancelled: Represents a run step that was cancelled. ,
failed: Represents a run step that failed. ,
completed: Represents a run step that successfully completed. ,
expired: Represents a run step that expired before otherwise finishing. ,
}
,
Required: True ,
}
enum ,
step_details:
{
Description: The details for this run step. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
message_creation: Represents a run step to create a message. ,
tool_calls: Represents a run step that calls tools. ,
}
,
Required: True ,
}
enum ,
}
,
last_error:
{
Description: If applicable, information about the last error encountered by this run step. ,
Required: True ,
}
object ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expired_at:
{
Description: The Unix timestamp, in seconds, representing when this item expired. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
usage:
{
Description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
GetRunStep (new)
Description :  Gets a single run step from a thread run.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs/{runId}/steps/{stepId}
{
threadId:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the specific run to retrieve the step from. ,
Required: True ,
}
string ,
stepId:
{
Description: The ID of the step to retrieve information about. ,
Required: True ,
}
string ,
include[]:
{
Description: A list of additional fields to include in the response. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run.step'. ,
Enum:
{
thread.run.step: No description available. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: The type of run step, which can be either message_creation or tool_calls. ,
Enum:
{
message_creation: Represents a run step to create a message. ,
tool_calls: Represents a run step that calls tools. ,
}
,
Required: True ,
}
enum ,
assistant_id:
{
Description: The ID of the assistant associated with the run step. ,
Required: True ,
}
string ,
thread_id:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
run_id:
{
Description: The ID of the run that this run step is a part of. ,
Required: True ,
}
string ,
status:
{
Description: The status of this run step. ,
Enum:
{
in_progress: Represents a run step still in progress. ,
cancelled: Represents a run step that was cancelled. ,
failed: Represents a run step that failed. ,
completed: Represents a run step that successfully completed. ,
expired: Represents a run step that expired before otherwise finishing. ,
}
,
Required: True ,
}
enum ,
step_details:
{
Description: The details for this run step. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
message_creation: Represents a run step to create a message. ,
tool_calls: Represents a run step that calls tools. ,
}
,
Required: True ,
}
enum ,
}
,
last_error:
{
Description: If applicable, information about the last error encountered by this run step. ,
Required: True ,
}
object ,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expired_at:
{
Description: The Unix timestamp, in seconds, representing when this item expired. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
usage:
{
Description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
SubmitToolOutputsToRun (new)
Description :  Submits outputs from tools as requested by tool calls in a run. Runs that need submitted tool outputs will have a status of 'requires_action' with a required_action.type of 'submit_tool_outputs'.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs/{runId}/submit_tool_outputs
{
threadId:
{
Description: The ID of the thread that was run. ,
Required: True ,
}
string ,
runId:
{
Description: The ID of the run that requires tool outputs. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
tool_outputs:
{
Description: A list of tools for which the outputs are being submitted. ,
Required: True ,
}
[
{
tool_call_id:
{
Description: The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. ,
Required: False ,
}
string ,
output:
{
Description: The output from the tool to be submitted. ,
Required: False ,
}
string ,
}
,
]
,
stream:
{
Description: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
CreateThreadAndRun (new)
Description :  Creates a new assistant thread and immediately starts a run using that new thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/runs
{
body:
{
Description: The details used when creating and immediately running a new assistant thread. ,
Required: True ,
}
{
assistant_id:
{
Description: The ID of the assistant for which the thread should be created. ,
Required: True ,
}
string ,
thread:
{
Description: The details used to create the new thread. If no thread is provided, an empty one will be created. ,
Required: False ,
}
{
messages:
{
Description: The initial messages to associate with the new thread. ,
Required: False ,
}
[
{
role:
{
Description: The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the assistant. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The textual content of the initial message. Currently, robust input including images and annotated text may only be provided via a separate call to the create message API. ,
Required: True ,
}
string ,
attachments:
{
Description: A list of files attached to the message, and the tools they should be added to. ,
Required: False ,
}
[
{
file_id:
{
Description: The ID of the file to attach to the message. ,
Required: True ,
}
string ,
tools:
{
Description: The tools to add to this file. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are made available to the assistant's tools in this thread. 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. ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
model:
{
Description: The overridden model that the assistant should use to run the thread. ,
Required: False ,
}
string ,
instructions:
{
Description: The overridden system instructions the assistant should use to run the thread. ,
Required: False ,
}
string ,
tools:
{
Description: The overridden list of enabled tools the assistant should use to run the thread. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: False ,
}
boolean ,
tool_resources:
{
Description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. ,
Required: False ,
}
object ,
stream:
{
Description: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. ,
Required: False ,
}
boolean ,
temperature:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: 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. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. ,
Format: int32 ,
Required: False ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. ,
Format: int32 ,
Required: False ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: False ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: False ,
}
string ,
response_format:
{
Description: Specifies the format that the model must output. ,
Required: False ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always 'thread.run'. ,
Enum:
{
thread.run: No description available. ,
}
,
Required: True ,
}
enum ,
thread_id:
{
Description: The ID of the thread associated with this run. ,
Required: True ,
}
string ,
assistant_id:
{
Description: The ID of the assistant associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the assistant thread run. ,
Enum:
{
queued: Represents a run that is queued to start. ,
in_progress: Represents a run that is in progress. ,
requires_action: Represents a run that needs another operation, such as tool output submission, to continue. ,
cancelling: Represents a run that is in the process of cancellation. ,
cancelled: Represents a run that has been cancelled. ,
failed: Represents a run that failed. ,
completed: Represents a run that successfully completed. ,
expired: Represents a run that expired before it could otherwise finish. ,
}
,
Required: True ,
}
enum ,
required_action:
{
Description: The details of the action required for the assistant thread run to continue. ,
Required: False ,
}
object ,
last_error:
{
Description: The last error, if any, encountered by this assistant thread run. ,
Required: True ,
}
object ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this assistant thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this assistant thread run. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
created_at:
{
Description: The Unix timestamp, in seconds, representing when this object was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
expires_at:
{
Description: The Unix timestamp, in seconds, representing when this item expires. ,
Format: unixtime ,
Required: True ,
}
integer ,
started_at:
{
Description: The Unix timestamp, in seconds, representing when this item was started. ,
Format: unixtime ,
Required: True ,
}
integer ,
completed_at:
{
Description: The Unix timestamp, in seconds, representing when this completed. ,
Format: unixtime ,
Required: True ,
}
integer ,
cancelled_at:
{
Description: The Unix timestamp, in seconds, representing when this was cancelled. ,
Format: unixtime ,
Required: True ,
}
integer ,
failed_at:
{
Description: The Unix timestamp, in seconds, representing when this failed. ,
Format: unixtime ,
Required: True ,
}
integer ,
incomplete_details:
{
Description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. ,
Enum:
{
max_completion_tokens: Maximum completion tokens exceeded ,
max_prompt_tokens: Maximum prompt tokens exceeded ,
}
,
Required: True ,
}
enum ,
usage:
{
Description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). ,
Required: True ,
}
object ,
temperature:
{
Description: The sampling temperature used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
top_p:
{
Description: The nucleus sampling value used for this run. If not set, defaults to 1. ,
Format: float ,
Required: False ,
}
number ,
max_prompt_tokens:
{
Description: The maximum number of prompt tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
max_completion_tokens:
{
Description: The maximum number of completion tokens specified to have been used over the course of the run. ,
Format: int32 ,
Required: True ,
}
integer ,
truncation_strategy:
{
Description: The strategy to use for dropping messages as the context windows moves forward. ,
Required: True ,
}
object ,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
parallel_tool_calls:
{
Description: Whether to enable parallel function calling during tool use. ,
Required: True ,
}
boolean ,
response_format:
{
Description: The response format of the tool calls used in this run. ,
Required: True ,
}
string ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
ListVectorStores (new)
Description :  Returns a list of vector stores.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores
{
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store` ,
Enum:
{
vector_store: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the vector store. ,
Required: True ,
}
string ,
usage_bytes:
{
Description: The total number of bytes used by the files in the vector store. ,
Format: int32 ,
Required: True ,
}
integer ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. ,
Enum:
{
expired: expired status indicates that this vector store has expired and is no longer available for use. ,
in_progress: in_progress status indicates that this vector store is still processing files. ,
completed: completed status indicates that this vector store is ready for use. ,
}
,
Required: True ,
}
enum ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
{
anchor:
{
Description: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. ,
Enum:
{
last_active_at: The expiration policy is based on the last time the vector store was active. ,
}
,
Required: True ,
}
enum ,
days:
{
Description: The anchor timestamp after which the expiration policy applies. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the vector store will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
last_active_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was last active. ,
Format: unixtime ,
Required: True ,
}
integer ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
CreateVectorStore (new)
Description :  Creates a vector store.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores
{
body:
{
Description: Request object for creating a vector store. ,
Required: True ,
}
{
file_ids:
{
Description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. ,
Required: False ,
}
[
string ,
]
,
name:
{
Description: The name of the vector store. ,
Required: False ,
}
string ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
{
anchor:
{
Description: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. ,
Enum:
{
last_active_at: The expiration policy is based on the last time the vector store was active. ,
}
,
Required: True ,
}
enum ,
days:
{
Description: The anchor timestamp after which the expiration policy applies. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
chunking_strategy:
{
Description: The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Enum:
{
auto: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store` ,
Enum:
{
vector_store: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the vector store. ,
Required: True ,
}
string ,
usage_bytes:
{
Description: The total number of bytes used by the files in the vector store. ,
Format: int32 ,
Required: True ,
}
integer ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. ,
Enum:
{
expired: expired status indicates that this vector store has expired and is no longer available for use. ,
in_progress: in_progress status indicates that this vector store is still processing files. ,
completed: completed status indicates that this vector store is ready for use. ,
}
,
Required: True ,
}
enum ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
{
anchor:
{
Description: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. ,
Enum:
{
last_active_at: The expiration policy is based on the last time the vector store was active. ,
}
,
Required: True ,
}
enum ,
days:
{
Description: The anchor timestamp after which the expiration policy applies. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the vector store will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
last_active_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was last active. ,
Format: unixtime ,
Required: True ,
}
integer ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
GetVectorStore (new)
Description :  Returns the vector store object matching the specified ID.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}
{
vectorStoreId:
{
Description: The ID of the vector store to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store` ,
Enum:
{
vector_store: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the vector store. ,
Required: True ,
}
string ,
usage_bytes:
{
Description: The total number of bytes used by the files in the vector store. ,
Format: int32 ,
Required: True ,
}
integer ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. ,
Enum:
{
expired: expired status indicates that this vector store has expired and is no longer available for use. ,
in_progress: in_progress status indicates that this vector store is still processing files. ,
completed: completed status indicates that this vector store is ready for use. ,
}
,
Required: True ,
}
enum ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
{
anchor:
{
Description: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. ,
Enum:
{
last_active_at: The expiration policy is based on the last time the vector store was active. ,
}
,
Required: True ,
}
enum ,
days:
{
Description: The anchor timestamp after which the expiration policy applies. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the vector store will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
last_active_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was last active. ,
Format: unixtime ,
Required: True ,
}
integer ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
ModifyVectorStore (new)
Description :  The ID of the vector store to modify.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}
{
vectorStoreId:
{
Description: The ID of the vector store to modify. ,
Required: True ,
}
string ,
body:
{
Description: Request object for updating a vector store. ,
Required: True ,
}
{
name:
{
Description: The name of the vector store. ,
Required: False ,
}
string ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
object ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store` ,
Enum:
{
vector_store: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
name:
{
Description: The name of the vector store. ,
Required: True ,
}
string ,
usage_bytes:
{
Description: The total number of bytes used by the files in the vector store. ,
Format: int32 ,
Required: True ,
}
integer ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. ,
Enum:
{
expired: expired status indicates that this vector store has expired and is no longer available for use. ,
in_progress: in_progress status indicates that this vector store is still processing files. ,
completed: completed status indicates that this vector store is ready for use. ,
}
,
Required: True ,
}
enum ,
expires_after:
{
Description: Details on when this vector store expires ,
Required: False ,
}
{
anchor:
{
Description: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`. ,
Enum:
{
last_active_at: The expiration policy is based on the last time the vector store was active. ,
}
,
Required: True ,
}
enum ,
days:
{
Description: The anchor timestamp after which the expiration policy applies. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
expires_at:
{
Description: The Unix timestamp (in seconds) for when the vector store will expire. ,
Format: unixtime ,
Required: False ,
}
integer ,
last_active_at:
{
Description: The Unix timestamp (in seconds) for when the vector store was last active. ,
Format: unixtime ,
Required: True ,
}
integer ,
metadata:
{
Description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length. ,
Required: True ,
}
object ,
}
DeleteVectorStore (new)
Description :  Deletes the vector store object matching the specified ID.
Reference :  Link ¶

⚼ Request

DELETE:  /vector_stores/{vectorStoreId}
{
vectorStoreId:
{
Description: The ID of the vector store to delete. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource specified for deletion. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether deletion was successful. ,
Required: True ,
}
boolean ,
object:
{
Description: The object type, which is always 'vector_store.deleted'. ,
Enum:
{
vector_store.deleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
CreateVectorStoreFileBatch (new)
Description :  Create a vector store file batch.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}/file_batches
{
vectorStoreId:
{
Description: The ID of the vector store for which to create a File Batch. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
file_ids:
{
Description: A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. ,
Required: True ,
}
[
string ,
]
,
chunking_strategy:
{
Description: The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Enum:
{
auto: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file_batch`. ,
Enum:
{
vector_store.files_batch: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store files batch was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. ,
Enum:
{
in_progress: The vector store is still processing this file batch. ,
completed: the vector store file batch is ready for use. ,
cancelled: The vector store file batch was cancelled. ,
failed: The vector store file batch failed to process. ,
}
,
Required: True ,
}
enum ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
GetVectorStoreFileBatch (new)
Description :  Retrieve a vector store file batch.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/file_batches/{batchId}
{
vectorStoreId:
{
Description: The ID of the vector store that the file batch belongs to. ,
Required: True ,
}
string ,
batchId:
{
Description: The ID of the file batch being retrieved. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file_batch`. ,
Enum:
{
vector_store.files_batch: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store files batch was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. ,
Enum:
{
in_progress: The vector store is still processing this file batch. ,
completed: the vector store file batch is ready for use. ,
cancelled: The vector store file batch was cancelled. ,
failed: The vector store file batch failed to process. ,
}
,
Required: True ,
}
enum ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
CancelVectorStoreFileBatch (new)
Description :  Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}/file_batches/{batchId}/cancel
{
vectorStoreId:
{
Description: The ID of the vector store that the file batch belongs to. ,
Required: True ,
}
string ,
batchId:
{
Description: The ID of the file batch to cancel. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file_batch`. ,
Enum:
{
vector_store.files_batch: No description available. ,
}
,
Required: True ,
}
enum ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store files batch was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. ,
Enum:
{
in_progress: The vector store is still processing this file batch. ,
completed: the vector store file batch is ready for use. ,
cancelled: The vector store file batch was cancelled. ,
failed: The vector store file batch failed to process. ,
}
,
Required: True ,
}
enum ,
file_counts:
{
Description: Files count grouped by status processed or being processed by this vector store. ,
Required: True ,
}
{
in_progress:
{
Description: The number of files that are currently being processed. ,
Format: int32 ,
Required: True ,
}
integer ,
completed:
{
Description: The number of files that have been successfully processed. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: The number of files that have failed to process. ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: The number of files that were cancelled. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: The total number of files. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
ListVectorStoreFileBatchFiles (new)
Description :  Returns a list of vector store files in a batch.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/file_batches/{batchId}/files
{
vectorStoreId:
{
Description: The ID of the vector store that the file batch belongs to. ,
Required: True ,
}
string ,
batchId:
{
Description: The ID of the file batch that the files belong to. ,
Required: True ,
}
string ,
filter:
{
Description: Filter by file status. ,
Required: False ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file`. ,
Enum:
{
vector_store.file: No description available. ,
}
,
Required: True ,
}
enum ,
usage_bytes:
{
Description: The total vector store usage in bytes. Note that this may be different from the original file size. ,
Format: int32 ,
Required: True ,
}
integer ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store file was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. ,
Enum:
{
in_progress: The file is currently being processed. ,
completed: The file has been successfully processed. ,
failed: The file has failed to process. ,
cancelled: The file was cancelled. ,
}
,
Required: True ,
}
enum ,
last_error:
{
Description: The last error associated with this vector store file. Will be `null` if there are no errors. ,
Required: True ,
}
object ,
chunking_strategy:
{
Description: The strategy used to chunk the file. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
other: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
ListVectorStoreFiles (new)
Description :  Returns a list of vector store files.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/files
{
vectorStoreId:
{
Description: The ID of the vector store that the files belong to. ,
Required: True ,
}
string ,
filter:
{
Description: Filter by file status. ,
Required: False ,
}
string ,
limit:
{
Description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. ,
Format: int32 ,
Required: False ,
}
integer ,
order:
{
Description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. ,
Required: False ,
}
string ,
after:
{
Description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. ,
Required: False ,
}
string ,
before:
{
Description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
object:
{
Description: The object type, which is always list. ,
Enum:
{
list: No description available. ,
}
,
Required: True ,
}
enum ,
data:
{
Description: The requested list of items. ,
Required: True ,
}
[
{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file`. ,
Enum:
{
vector_store.file: No description available. ,
}
,
Required: True ,
}
enum ,
usage_bytes:
{
Description: The total vector store usage in bytes. Note that this may be different from the original file size. ,
Format: int32 ,
Required: True ,
}
integer ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store file was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. ,
Enum:
{
in_progress: The file is currently being processed. ,
completed: The file has been successfully processed. ,
failed: The file has failed to process. ,
cancelled: The file was cancelled. ,
}
,
Required: True ,
}
enum ,
last_error:
{
Description: The last error associated with this vector store file. Will be `null` if there are no errors. ,
Required: True ,
}
object ,
chunking_strategy:
{
Description: The strategy used to chunk the file. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
other: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
first_id:
{
Description: The first ID represented in this list. ,
Required: True ,
}
string ,
last_id:
{
Description: The last ID represented in this list. ,
Required: True ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
CreateVectorStoreFile (new)
Description :  Create a vector store file by attaching a file to a vector store.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}/files
{
vectorStoreId:
{
Description: The ID of the vector store for which to create a File. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
file_id:
{
Description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. ,
Required: True ,
}
string ,
chunking_strategy:
{
Description: The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Enum:
{
auto: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file`. ,
Enum:
{
vector_store.file: No description available. ,
}
,
Required: True ,
}
enum ,
usage_bytes:
{
Description: The total vector store usage in bytes. Note that this may be different from the original file size. ,
Format: int32 ,
Required: True ,
}
integer ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store file was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. ,
Enum:
{
in_progress: The file is currently being processed. ,
completed: The file has been successfully processed. ,
failed: The file has failed to process. ,
cancelled: The file was cancelled. ,
}
,
Required: True ,
}
enum ,
last_error:
{
Description: The last error associated with this vector store file. Will be `null` if there are no errors. ,
Required: True ,
}
object ,
chunking_strategy:
{
Description: The strategy used to chunk the file. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
other: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
GetVectorStoreFile (new)
Description :  Retrieves a vector store file.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/files/{fileId}
{
vectorStoreId:
{
Description: The ID of the vector store that the file belongs to. ,
Required: True ,
}
string ,
fileId:
{
Description: The ID of the file being retrieved. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The identifier, which can be referenced in API endpoints. ,
Required: True ,
}
string ,
object:
{
Description: The object type, which is always `vector_store.file`. ,
Enum:
{
vector_store.file: No description available. ,
}
,
Required: True ,
}
enum ,
usage_bytes:
{
Description: The total vector store usage in bytes. Note that this may be different from the original file size. ,
Format: int32 ,
Required: True ,
}
integer ,
created_at:
{
Description: The Unix timestamp (in seconds) for when the vector store file was created. ,
Format: unixtime ,
Required: True ,
}
integer ,
vector_store_id:
{
Description: The ID of the vector store that the file is attached to. ,
Required: True ,
}
string ,
status:
{
Description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. ,
Enum:
{
in_progress: The file is currently being processed. ,
completed: The file has been successfully processed. ,
failed: The file has failed to process. ,
cancelled: The file was cancelled. ,
}
,
Required: True ,
}
enum ,
last_error:
{
Description: The last error associated with this vector store file. Will be `null` if there are no errors. ,
Required: True ,
}
object ,
chunking_strategy:
{
Description: The strategy used to chunk the file. ,
Required: True ,
}
{
type:
{
Description: The object type. ,
Enum:
{
other: No description available. ,
static: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
DeleteVectorStoreFile (new)
Description :  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.
Reference :  Link ¶

⚼ Request

DELETE:  /vector_stores/{vectorStoreId}/files/{fileId}
{
vectorStoreId:
{
Description: The ID of the vector store that the file belongs to. ,
Required: True ,
}
string ,
fileId:
{
Description: The ID of the file to delete its relationship to the vector store. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource specified for deletion. ,
Required: True ,
}
string ,
deleted:
{
Description: A value indicating whether deletion was successful. ,
Required: True ,
}
boolean ,
object:
{
Description: The object type, which is always 'vector_store.deleted'. ,
Enum:
{
vector_store.file.deleted: No description available. ,
}
,
Required: True ,
}
enum ,
}