Azure.AI.Agents (stable:v1)

2025/07/21 • 1 updated methods

Runs_CreateRun (updated)
Description :  Creates a new run for an agent thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Runs_CreateRun",
  "$parameters": {
    "body": {
      "$properties": {
        "@added_08b90df5dfae4106ac3b235b4d9d65d1": {
          "#name": "tool_resources",
          "Description": "The overridden enabled tool resources that the agent should use to run the thread.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code_interpreter",
              "Description": "Resources to be used by the `code_interpreter` tool consisting of file IDs.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "file_ids",
                  "Description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files\nassociated with the tool.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "data_sources",
                  "Description": "The data sources to be used. This option is mutually exclusive with the `fileIds` property.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "The structure, containing Azure asset URI path and the asset type of the file used as a data source\nfor the enterprise file search.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "uri",
                        "Description": "Asset URI.",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "type",
                        "Description": "The asset type",
                        "Enum": [
                          [
                            "uri_asset",
                            "Azure URI"
                          ],
                          [
                            "id_asset",
                            "The data ID"
                          ]
                        ],
                        "Required": true,
                        "Type": "string"
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "file_search",
              "Description": "Resources to be used by the `file_search` tool consisting of vector store IDs.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "vector_store_ids",
                  "Description": "The ID of the vector store attached to this agent. There can be a maximum of 1 vector\nstore attached to the agent.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "vector_stores",
                  "Description": "The list of vector store configuration objects from Azure.\nThis list is limited to one element.\nThe only element of this list contains the list of azure asset IDs used by the search tool.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "The structure, containing the list of vector storage configurations i.e. the list of azure asset IDs.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "name",
                        "Description": "Name",
                        "Required": true,
                        "Type": "string"
                      },
                      {
                        "#name": "configuration",
                        "Description": "Configurations",
                        "Required": true,
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "data_sources",
                            "Description": "Data sources",
                            "Required": true,
                            "Type": "array",
                            "$items": {
                              "Description": "The structure, containing Azure asset URI path and the asset type of the file used as a data source\nfor the enterprise file search.",
                              "Type": "object",
                              "$properties": [
                                {
                                  "#name": "uri",
                                  "Description": "Asset URI.",
                                  "Required": true,
                                  "Type": "string"
                                },
                                {
                                  "#name": "type",
                                  "Description": "The asset type",
                                  "Enum": [
                                    [
                                      "uri_asset",
                                      "Azure URI"
                                    ],
                                    [
                                      "id_asset",
                                      "The data ID"
                                    ]
                                  ],
                                  "Required": true,
                                  "Type": "string"
                                }
                              ]
                            }
                          }
                        ]
                      }
                    ]
                  }
                }
              ]
            },
            {
              "#name": "azure_ai_search",
              "Description": "Resources to be used by the `azure_ai_search` tool consisting of index IDs and names.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "indexes",
                  "Description": "The indices attached to this agent. There can be a maximum of 1 index\nresource attached to the agent.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "A AI Search Index resource.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "index_connection_id",
                        "Description": "An index connection id in an IndexResource attached to this agent.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "index_name",
                        "Description": "The name of an index in an IndexResource attached to this agent.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "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,
                        "Type": "string"
                      },
                      {
                        "#name": "top_k",
                        "Description": "Number of documents to retrieve from search and present to the model.",
                        "Format": "int32",
                        "Required": false,
                        "Type": "integer"
                      },
                      {
                        "#name": "filter",
                        "Description": "filter string for search resource.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "index_asset_id",
                        "Description": "Index asset id for search resource.",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ 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 ,
}
,
]
,
tool_resources:
{
Description: The overridden enabled tool resources that the agent should use to run the thread. ,
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 ,
}
,
}