Sign in
Assistants

Modifies an assistant.

post/assistants/{assistant_id}

Path parameters

assistant_idstring required

The ID of the assistant to modify.

Request body

modelstring

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

namestring nullable

The name of the assistant. The maximum length is 256 characters.

descriptionstring nullable

The description of the assistant. The maximum length is 512 characters.

instructionsstring nullable

The system instructions that the assistant uses. The maximum length is 256,000 characters.

metadataobject nullable

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

temperaturenumber 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 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.

Example request

{
  "temperature": 1,
  "top_p": 1
}

Response

OK

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) for when the assistant was created.

namestring nullable required

The name of the assistant. The maximum length is 256 characters.

descriptionstring nullable required

The description of the assistant. The maximum length is 512 characters.

modelstring required

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

instructionsstring nullable required

The system instructions that the assistant uses. The maximum length is 256,000 characters.

metadataobject nullable required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

temperaturenumber 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 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.

Example response

{
  "temperature": 1,
  "top_p": 1
}

Changes

Changed in 6 of the 35 revisions of this API.6113

  • b60d5559d51522See the full diff
    • ▲

      removed subschema #1 from the response_format request property oneOf list

      request-property-one-of-removed

    • ▲

      added subschema #1: Behavior to the response_format response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added subschema #1: Behavior to the response_format request property oneOf list

      request-property-one-of-added

    • ○

      removed subschema #1 from the response_format response property oneOf list for the response status 200

      response-property-one-of-removed

  • 501122aa32ad11See the full diff
    • ▲

      the request property tools/items/oneOf[subschema #2: FileSearch tool]/file_search/ranking_options/score_threshold became required

      request-property-became-required

    • ○

      the response property tools/items/oneOf[subschema #2: FileSearch tool]/file_search/ranking_options/score_threshold became required for the status 200

      response-property-became-required

  • 1dbac0e95bdb2See the full diff
    • ○

      added the new optional request property tools/items/oneOf[subschema #2: FileSearch tool]/file_search/ranking_options

      new-optional-request-property

    • ○

      added the optional property tools/items/oneOf[subschema #2: FileSearch tool]/file_search/ranking_options to the response with the 200 status

      response-optional-property-added

  • 4097c2f86beb22See the full diff
    • ▲

      removed AssistantsApiResponseFormat from the response_format request property oneOf list

      request-property-one-of-removed

    • ▲

      added ResponseFormatText ResponseFormatJsonObject ResponseFormatJsonSchema to the response_format response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added ResponseFormatText ResponseFormatJsonObject ResponseFormatJsonSchema to the response_format request property oneOf list

      request-property-one-of-added

    • ○

      removed AssistantsApiResponseFormat from the response_format response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c36d30a94622114See the full diff
    • ▲

      removed the enum value none of the request property response_format/oneOf[subschema #1]/

      request-property-enum-value-removed

    • ●

      added the new json_schema enum value to the response_format/oneOf[AssistantsApiResponseFormat]/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property tools/items/oneOf[subschema #3: Function tool]/function/strict

      new-optional-request-property

    • ○

      added the new json_schema enum value to the request property response_format/oneOf[AssistantsApiResponseFormat]/type

      request-property-enum-value-added

    • ○

      added the optional property tools/items/oneOf[subschema #3: Function tool]/function/strict to the response with the 200 status

      response-optional-property-added

    • ○

      removed the none enum value from the response_format/oneOf[subschema #1]/ response property for the response status 200

      response-property-enum-value-removed

  • 0577fd0d08da2See the full diff
    • ○

      added the new optional request property tools/items/oneOf[subschema #2: FileSearch tool]/file_search

      new-optional-request-property

    • ○

      added the optional property tools/items/oneOf[subschema #2: FileSearch tool]/file_search to the response with the 200 status

      response-optional-property-added