Sign in

v3

latestSwagger 2.02026-07-1342207288.7 KB

Modifies an existing agent.

post/assistants/{assistantId}

Path parameters

assistantIdstring required

The ID of the agent to modify.

Query parameters

api-versionstring required

The API version to use for this operation.

Request body

modelstring

The ID of the model to use.

namestring nullable

The modified name for the agent to use.

descriptionstring nullable

The modified description for the agent to use.

instructionsstring nullable

The modified system instructions for the new agent to use.

temperaturenumber float nullable

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.

top_pnumber float nullable

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.

{"stackTrail":"components:schemas:AgentsResponseFormatOption","oasType":"schema","type":"unknown"}
metadataobject nullable

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.

Response

The updated agent instance.

idstring required

The identifier, which can be referenced in API endpoints.

object'assistant' required

The object type, which is always assistant.

created_atinteger required

The Unix timestamp, in seconds, representing when this object was created.

namestring nullable required

The name of the agent.

descriptionstring nullable required

The description of the agent.

modelstring required

The ID of the model to use.

instructionsstring nullable required

The system instructions for the agent to use.

temperaturenumber float nullable required

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.

top_pnumber float nullable required

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.

{"stackTrail":"components:schemas:AgentsResponseFormatOption","oasType":"schema","type":"unknown"}
metadataobject nullable required

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.