Azure.AI.Agents (stable:v1)

2025/05/14 • 41 new methods

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

⚼ Request

GET:  /assistants
{
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 agent. ,
Required: True ,
}
string ,
description:
{
Description: The description of the agent. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the agent to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the agent. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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: 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 agent. ,
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 ,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
CreateAgent (new)
Description :  Creates a new agent.
Reference :  Link ¶

⚼ Request

POST:  /assistants
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
name:
{
Description: The name of the new agent. ,
Required: False ,
}
string ,
description:
{
Description: The description of the new agent. ,
Required: False ,
}
string ,
instructions:
{
Description: The system instructions for the new agent to use. ,
Required: False ,
}
string ,
tools:
{
Description: The collection of tools to enable for the new agent. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the agent'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: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 agent. ,
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 agent. ,
Required: True ,
}
string ,
description:
{
Description: The description of the agent. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the agent to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the agent. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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: 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 agent. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
GetAgent (new)
Description :  Retrieves an existing agent.
Reference :  Link ¶

⚼ Request

GET:  /assistants/{assistantId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assistantId:
{
Description: Identifier of the agent. ,
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 agent. ,
Required: True ,
}
string ,
description:
{
Description: The description of the agent. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the agent to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the agent. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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: 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 agent. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
UpdateAgent (new)
Description :  Modifies an existing agent.
Reference :  Link ¶

⚼ Request

POST:  /assistants/{assistantId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assistantId:
{
Description: The ID of the agent to modify. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
model:
{
Description: The ID of the model to use. ,
Required: False ,
}
string ,
name:
{
Description: The modified name for the agent to use. ,
Required: False ,
}
string ,
description:
{
Description: The modified description for the agent to use. ,
Required: False ,
}
string ,
instructions:
{
Description: The modified system instructions for the new agent to use. ,
Required: False ,
}
string ,
tools:
{
Description: The modified collection of tools to enable for the agent. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the agent'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: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 agent. ,
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 agent. ,
Required: True ,
}
string ,
description:
{
Description: The description of the agent. ,
Required: True ,
}
string ,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The system instructions for the agent to use. ,
Required: True ,
}
string ,
tools:
{
Description: The collection of tools enabled for the agent. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: A set of resources that are used by the agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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: 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 agent. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
DeleteAgent (new)
Description :  Deletes an agent.
Reference :  Link ¶

⚼ Request

DELETE:  /assistants/{assistantId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
assistantId:
{
Description: Identifier of the agent. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Files_ListFiles (new)
Description :  Gets a list of previously uploaded files.
Reference :  Link ¶

⚼ Request

GET:  /files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
purpose:
{
Description: The purpose of the file. ,
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:
{
assistants: Indicates a file is used as input to agents. ,
assistants_output: Indicates a file is used as output by agents. ,
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 ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Files_UploadFile (new)
Description :  Uploads a file for use by other operations.
Reference :  Link ¶

⚼ Request

POST:  /files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
file:
{
Description: The file data, in bytes. ,
Required: True ,
}
file ,
purpose:
{
Description: The intended purpose of the uploaded file. Use `assistants` for Agents and Message files, `vision` for Agents image file inputs, `batch` for Batch API, and `fine-tune` for Fine-tuning. ,
Required: True ,
}
string ,
filename:
{
Description: The name of the file. ,
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:
{
assistants: Indicates a file is used as input to agents. ,
assistants_output: Indicates a file is used as output by agents. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Files_GetFile (new)
Description :  Returns information about a specific file. Does not retrieve file content.
Reference :  Link ¶

⚼ Request

GET:  /files/{fileId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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:
{
assistants: Indicates a file is used as input to agents. ,
assistants_output: Indicates a file is used as output by agents. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Files_DeleteFile (new)
Description :  Delete a previously uploaded file.
Reference :  Link ¶

⚼ Request

DELETE:  /files/{fileId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Files_GetFileContent (new)
Description :  Retrieves the raw content of a specific file.
Reference :  Link ¶

⚼ Request

GET:  /files/{fileId}/content
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
fileId:
{
Description: The ID of the file to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Threads_ListThreads (new)
Description :  Gets a list of threads that were previously created.
Reference :  Link ¶

⚼ Request

GET:  /threads
{
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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'. ,
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 agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 ,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Threads_CreateThread (new)
Description :  Creates a new thread. Threads contain messages and can be run by agents.
Reference :  Link ¶

⚼ Request

POST:  /threads
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
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`, which indicates the message is sent by an actual user (and should be used in most cases to represent user-generated messages), and `assistant`, which indicates the message is generated by the agent (use this value to insert messages from the agent into the conversation). ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content of the initial message. This may be a basic string (if you only need text) or an array of typed content blocks (for example, text, image_file, image_url, and so on). ,
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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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'. ,
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 agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Threads_GetThread (new)
Description :  Gets information about an existing thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the 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'. ,
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 agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Threads_UpdateThread (new)
Description :  Modifies an existing thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: The ID of the thread to modify. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
tool_resources:
{
Description: A set of resources that are made available to the agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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'. ,
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 agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Threads_DeleteThread (new)
Description :  Deletes an existing thread.
Reference :  Link ¶

⚼ Request

DELETE:  /threads/{threadId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Messages_ListMessages (new)
Description :  Gets a list of messages that exist on a thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/messages
{
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
run_id:
{
Description: Filter messages by the run ID that generated them. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 ,
}
{
reason:
{
Description: The provided reason describing why the message was marked as incomplete. ,
Enum:
{
content_filter: The run generating the message was terminated due to content filter flagging. ,
max_tokens: The run generating the message exhausted available tokens before completion. ,
run_cancelled: The run generating the message was cancelled before completion. ,
run_failed: The run generating the message failed. ,
run_expired: The run generating the message expired. ,
}
,
Required: True ,
}
enum ,
}
,
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 agent thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the agent thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the agent 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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 ,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}
Messages_CreateMessage (new)
Description :  Creates a new message on a specified thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/messages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
role:
{
Description: The role of the entity that is creating the message. Allowed values include: `user`, which indicates the message is sent by an actual user (and should be used in most cases to represent user-generated messages), and `assistant`, which indicates the message is generated by the agent (use this value to insert messages from the agent into the conversation). ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content of the initial message. This may be a basic string (if you only need text) or an array of typed content blocks (for example, text, image_file, image_url, and so on). ,
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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 ,
}
{
reason:
{
Description: The provided reason describing why the message was marked as incomplete. ,
Enum:
{
content_filter: The run generating the message was terminated due to content filter flagging. ,
max_tokens: The run generating the message exhausted available tokens before completion. ,
run_cancelled: The run generating the message was cancelled before completion. ,
run_failed: The run generating the message failed. ,
run_expired: The run generating the message expired. ,
}
,
Required: True ,
}
enum ,
}
,
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 agent thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the agent thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the agent 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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Messages_GetMessage (new)
Description :  Retrieves an existing message.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/messages/{messageId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
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 ,
}
{
reason:
{
Description: The provided reason describing why the message was marked as incomplete. ,
Enum:
{
content_filter: The run generating the message was terminated due to content filter flagging. ,
max_tokens: The run generating the message exhausted available tokens before completion. ,
run_cancelled: The run generating the message was cancelled before completion. ,
run_failed: The run generating the message failed. ,
run_expired: The run generating the message expired. ,
}
,
Required: True ,
}
enum ,
}
,
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 agent thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the agent thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the agent 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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Messages_UpdateMessage (new)
Description :  Modifies an existing message on an existing thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/messages/{messageId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
messageId:
{
Description: Identifier of the message. ,
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 ,
}
{
reason:
{
Description: The provided reason describing why the message was marked as incomplete. ,
Enum:
{
content_filter: The run generating the message was terminated due to content filter flagging. ,
max_tokens: The run generating the message exhausted available tokens before completion. ,
run_cancelled: The run generating the message was cancelled before completion. ,
run_failed: The run generating the message failed. ,
run_expired: The run generating the message expired. ,
}
,
Required: True ,
}
enum ,
}
,
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 agent thread message. ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The list of content items associated with the agent thread message. ,
Required: True ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
assistant_id:
{
Description: If applicable, the ID of the agent 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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Runs_ListRuns (new)
Description :  Gets a list of runs for a specified thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs
{
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Runs_CreateRun (new)
Description :  Creates a new run for an agent thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
include[]:
{
Description: A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. ,
Required: False ,
}
array ,
body:
{
Required: True ,
}
{
assistant_id:
{
Description: The ID of the agent that should run the thread. ,
Required: True ,
}
string ,
model:
{
Description: The overridden model name that the agent should use to run the thread. ,
Required: False ,
}
string ,
instructions:
{
Description: The overridden system instructions that the agent 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 ,
}
[
{
role:
{
Description: The role of the entity that is creating the message. Allowed values include: `user`, which indicates the message is sent by an actual user (and should be used in most cases to represent user-generated messages), and `assistant`, which indicates the message is generated by the agent (use this value to insert messages from the agent into the conversation). ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content of the initial message. This may be a basic string (if you only need text) or an array of typed content blocks (for example, text, image_file, image_url, and so on). ,
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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 ,
}
,
]
,
tools:
{
Description: The overridden list of enabled tools that the agent should use to run the thread. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
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 ,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
parallel_tool_calls:
{
Description: If `true` functions will run in parallel during tool use. ,
Required: False ,
}
boolean ,
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Runs_GetRun (new)
Description :  Gets an existing run from an existing thread.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs/{runId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
runId:
{
Description: Identifier of the run. ,
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Runs_UpdateRun (new)
Description :  Modifies an existing thread run.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs/{runId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
runId:
{
Description: Identifier of the run. ,
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Runs_CancelRun (new)
Description :  Cancels a run of an in‐progress thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs/{runId}/cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
runId:
{
Description: Identifier of the run. ,
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
RunSteps_ListRunSteps (new)
Description :  Gets a list of run steps from a thread run.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs/{runId}/steps
{
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
runId:
{
Description: Identifier of the run. ,
Required: True ,
}
string ,
include[]:
{
Description: A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. ,
Required: False ,
}
array ,
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 agent 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 ,
}
{
code:
{
Description: The error code for this error. ,
Enum:
{
server_error: Represents a server error. ,
rate_limit_exceeded: Represents an error indicating configured rate limits were exceeded. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The human-readable text associated with this error. ,
Required: True ,
}
string ,
}
,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run step. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run step. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
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 ,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
RunSteps_GetRunStep (new)
Description :  Retrieves a single run step from a thread run.
Reference :  Link ¶

⚼ Request

GET:  /threads/{threadId}/runs/{runId}/steps/{stepId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
runId:
{
Description: Identifier of the run. ,
Required: True ,
}
string ,
stepId:
{
Description: Identifier of the run step. ,
Required: True ,
}
string ,
include[]:
{
Description: A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content. ,
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 agent 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 ,
}
{
code:
{
Description: The error code for this error. ,
Enum:
{
server_error: Represents a server error. ,
rate_limit_exceeded: Represents an error indicating configured rate limits were exceeded. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: The human-readable text associated with this error. ,
Required: True ,
}
string ,
}
,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run step. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run step. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
Runs_SubmitToolOutputsToRun (new)
Description :  Submits outputs from tools as requested by tool calls in a run.
Reference :  Link ¶

⚼ Request

POST:  /threads/{threadId}/runs/{runId}/submit_tool_outputs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
threadId:
{
Description: Identifier of the thread. ,
Required: True ,
}
string ,
runId:
{
Description: Identifier of the run. ,
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 SSE, terminating at `[DONE]`. ,
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
CreateThreadAndRun (new)
Description :  Creates a new agent thread and immediately starts a run using that new thread.
Reference :  Link ¶

⚼ Request

POST:  /threads/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
assistant_id:
{
Description: The ID of the agent 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`, which indicates the message is sent by an actual user (and should be used in most cases to represent user-generated messages), and `assistant`, which indicates the message is generated by the agent (use this value to insert messages from the agent into the conversation). ,
Enum:
{
user: The role representing the end-user. ,
assistant: The role representing the agent. ,
}
,
Required: True ,
}
enum ,
content:
{
Description: The content of the initial message. This may be a basic string (if you only need text) or an array of typed content blocks (for example, text, image_file, image_url, and so on). ,
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: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
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 agent'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 ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 ,
}
,
model:
{
Description: The overridden model that the agent should use to run the thread. ,
Required: False ,
}
string ,
instructions:
{
Description: The overridden system instructions the agent should use to run the thread. ,
Required: False ,
}
string ,
tools:
{
Description: The overridden list of enabled tools the agent should use to run the thread. ,
Required: False ,
}
[
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
]
,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
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 ,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
parallel_tool_calls:
{
Description: If `true` functions will run in parallel during tool use. ,
Required: False ,
}
boolean ,
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 agent associated with the thread this run was performed against. ,
Required: True ,
}
string ,
status:
{
Description: The status of the agent 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 agent thread run to continue. ,
Required: False ,
}
{
type:
{
Description: The object type. ,
Required: True ,
}
string ,
}
,
last_error:
{
Description: The last error, if any, encountered by this agent thread run. ,
Required: True ,
}
{
code:
{
Description: The status for the error. ,
Required: True ,
}
string ,
message:
{
Description: The human-readable text associated with the error. ,
Required: True ,
}
string ,
}
,
model:
{
Description: The ID of the model to use. ,
Required: True ,
}
string ,
instructions:
{
Description: The overridden system instructions used for this agent thread run. ,
Required: True ,
}
string ,
tools:
{
Description: The overridden enabled tools used for this agent 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. ,
Required: True ,
}
{
reason:
{
Description: The reason why the run is incomplete. This indicates which specific token limit was reached during the run. ,
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 ,
}
{
completion_tokens:
{
Description: Number of completion tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
prompt_tokens:
{
Description: Number of prompt tokens used over the course of the run. ,
Format: int64 ,
Required: True ,
}
integer ,
total_tokens:
{
Description: Total number of tokens used (prompt + completion). ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
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 ,
}
{
type:
{
Description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the `lastMessages` count most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. ,
Enum:
{
auto: Default value. Messages in the middle of the thread will be dropped to fit the context length of the model. ,
last_messages: The thread will truncate to the `lastMessages` count of recent messages. ,
}
,
Required: True ,
}
enum ,
last_messages:
{
Description: The number of most recent messages from the thread when constructing the context for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tool_choice:
{
Description: Controls whether or not and which tool is called by the model. ,
Required: True ,
}
string ,
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 ,
tool_resources:
{
Description: Override the tools the agent can use for this run. This is useful for modifying the behavior on a per-run basis ,
Required: False ,
}
{
code_interpreter:
{
Description: Resources to be used by the `code_interpreter` tool consisting of file IDs. ,
Required: False ,
}
{
file_ids:
{
Description: A 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 ,
}
[
string ,
]
,
data_sources:
{
Description: The data sources to be used. This option is mutually exclusive with the `fileIds` property. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
file_search:
{
Description: Resources to be used by the `file_search` tool consisting of vector store IDs. ,
Required: False ,
}
{
vector_store_ids:
{
Description: The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent. ,
Required: False ,
}
[
string ,
]
,
vector_stores:
{
Description: The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool. ,
Required: False ,
}
[
{
name:
{
Description: Name ,
Required: True ,
}
string ,
configuration:
{
Description: Configurations ,
Required: True ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}
,
azure_ai_search:
{
Description: Resources to be used by the `azure_ai_search` tool consisting of index IDs and names. ,
Required: False ,
}
{
indexes:
{
Description: The indices attached to this agent. There can be a maximum of 1 index resource attached to the agent. ,
Required: False ,
}
[
{
index_connection_id:
{
Description: An index connection id in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
index_name:
{
Description: The name of an index in an IndexResource attached to this agent. ,
Required: False ,
}
string ,
query_type:
{
Description: Type of query in an AIIndexResource attached to this agent. ,
Enum:
{
simple: Query type `simple` ,
semantic: Query type `semantic` ,
vector: Query type `vector` ,
vector_simple_hybrid: Query type `vector_simple_hybrid` ,
vector_semantic_hybrid: Query type `vector_semantic_hybrid` ,
}
,
Required: False ,
}
enum ,
top_k:
{
Description: Number of documents to retrieve from search and present to the model. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: filter string for search resource. ,
Required: False ,
}
string ,
index_asset_id:
{
Description: Index asset id for search resource. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
parallel_tool_calls:
{
Description: Determines if tools can be executed in parallel within the run. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStores_ListVectorStores (new)
Description :  Returns a list of vector stores.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores
{
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 ,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStores_CreateVectorStore (new)
Description :  Creates a vector store.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores
{
api-version:
{
Description: The API version to use for this operation. ,
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: False ,
}
[
string ,
]
,
name:
{
Description: The name of the vector store. ,
Required: False ,
}
string ,
configuration:
{
Description: The vector store configuration, used when vector store is created from Azure asset URIs. ,
Required: False ,
}
{
data_sources:
{
Description: Data sources ,
Required: True ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
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 ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStores_GetVectorStore (new)
Description :  Returns the vector store object matching the specified ID.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStores_ModifyVectorStore (new)
Description :  Modifies an existing vector store.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
body:
{
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 ,
}
{
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 ,
}
,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStores_DeleteVectorStore (new)
Description :  Deletes the vector store object matching the specified ID.
Reference :  Link ¶

⚼ Request

DELETE:  /vector_stores/{vectorStoreId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of 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.deleted: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFileBatches_CreateVectorStoreFileBatch (new)
Description :  Create a vector store file batch.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}/file_batches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
file_ids:
{
Description: List of file identifiers. ,
Required: False ,
}
[
string ,
]
,
data_sources:
{
Description: List of Azure assets. ,
Required: False ,
}
[
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
]
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFileBatches_GetVectorStoreFileBatch (new)
Description :  Retrieve a vector store file batch.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/file_batches/{batchId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
batchId:
{
Description: Identifier of the file batch. ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFileBatches_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
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
batchId:
{
Description: Identifier of the file batch. ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFileBatches_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: Identifier of the vector store. ,
Required: True ,
}
string ,
batchId:
{
Description: Identifier of the file batch. ,
Required: True ,
}
string ,
filter:
{
Description: Filter by file status. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 ,
}
{
code:
{
Description: One of `server_error` or `rate_limit_exceeded`. ,
Enum:
{
server_error: An server error occurred. ,
invalid_file: The file is not valid. ,
unsupported_file: The file is of unsupported type. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable description of the error. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFiles_ListVectorStoreFiles (new)
Description :  Returns a list of vector store files.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/files
{
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
filter:
{
Description: Filter by file status. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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, ending 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)

{
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 ,
}
{
code:
{
Description: One of `server_error` or `rate_limit_exceeded`. ,
Enum:
{
server_error: An server error occurred. ,
invalid_file: The file is not valid. ,
unsupported_file: The file is of unsupported type. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable description of the error. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}
,
]
,
last_id:
{
Description: The last ID represented in this list. ,
Required: False ,
}
string ,
has_more:
{
Description: A value indicating whether there are additional values available not captured in this list. ,
Required: True ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFiles_CreateVectorStoreFile (new)
Description :  Create a vector store file by attaching a file to a vector store.
Reference :  Link ¶

⚼ Request

POST:  /vector_stores/{vectorStoreId}/files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
file_id:
{
Description: Identifier of the file. ,
Required: False ,
}
string ,
data_source:
{
Description: Azure asset ID. ,
Required: False ,
}
{
uri:
{
Description: Asset URI. ,
Required: True ,
}
string ,
type:
{
Description: The asset type ,
Enum:
{
uri_asset: Azure URI ,
id_asset: The data ID ,
}
,
Required: True ,
}
enum ,
}
,
chunking_strategy:
{
Description: The chunking strategy used to chunk the file. If not set, uses 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 ,
}
{
code:
{
Description: One of `server_error` or `rate_limit_exceeded`. ,
Enum:
{
server_error: An server error occurred. ,
invalid_file: The file is not valid. ,
unsupported_file: The file is of unsupported type. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable description of the error. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFiles_GetVectorStoreFile (new)
Description :  Retrieves a vector store file.
Reference :  Link ¶

⚼ Request

GET:  /vector_stores/{vectorStoreId}/files/{fileId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
fileId:
{
Description: Identifier of the file. ,
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 ,
}
{
code:
{
Description: One of `server_error` or `rate_limit_exceeded`. ,
Enum:
{
server_error: An server error occurred. ,
invalid_file: The file is not valid. ,
unsupported_file: The file is of unsupported type. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable description of the error. ,
Required: True ,
}
string ,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}
VectorStoreFiles_DeleteVectorStoreFile (new)
Description :  Deletes a vector store file. This removes the file‐to‐store link (does not delete the file itself).
Reference :  Link ¶

⚼ Request

DELETE:  /vector_stores/{vectorStoreId}/files/{fileId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vectorStoreId:
{
Description: Identifier of the vector store. ,
Required: True ,
}
string ,
fileId:
{
Description: Identifier of the file. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: Represents the error. ,
Required: True ,
}
{
message:
{
Description: Human-readable description of the error. ,
Required: False ,
}
string ,
type:
{
Description: Error type identifier (e.g. `invalid_request_error`). ,
Required: False ,
}
string ,
param:
{
Description: Name of the parameter that caused the error, if applicable. ,
Required: False ,
}
string ,
code:
{
Description: Machine-readable error code. ,
Required: False ,
}
string ,
}
,
}