CreateAgentOptions interface
The request details to use when creating a new agent.
Properties
| description | The description of the new agent. |
| instructions | The system instructions for the new agent to use. |
| metadata | 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. |
| model | The ID of the model to use. |
| name | The name of the new agent. |
| response |
The response format of the tool calls used by this agent. |
| temperature | 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. |
| tool |
A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the |
| tools | The collection of tools to enable for the new agent. |
| topP | 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. |
Property Details
description
The description of the new agent.
description?: null | stringProperty Value
null | string
instructions
The system instructions for the new agent to use.
instructions?: null | stringProperty Value
null | string
metadata
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.
metadata?: null | Record<string, string>Property Value
null | Record<string, string>
model
The ID of the model to use.
model: stringProperty Value
string
name
The name of the new agent.
name?: null | stringProperty Value
null | string
responseFormat
The response format of the tool calls used by this agent.
responseFormat?: null | AgentsApiResponseFormatOptionProperty Value
temperature
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.
temperature?: null | numberProperty Value
null | number
toolResources
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.
toolResources?: null | ToolResourcesProperty Value
null | ToolResources
tools
The collection of tools to enable for the new agent.
tools?: ToolDefinition[]Property Value
topP
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.
topP?: null | numberProperty Value
null | number
