OMomnistack-sh
Assistants

Create assistant

Changed on

Create an assistant with a model and instructions.

post/assistants

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/assistants
  • Auth
    HTTP bearer

Request body

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.

reasoning_effort'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' nullable

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.

metadataMetadata 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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

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.

metadataMetadata 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, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

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

  • 487892d3954eRevision changes
    • info

      added the optional property // to the response with the status

  • 7f654af7f94fRevision changes
    • breaking

      removed subschema #2 from the request property anyOf list

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed subschema #1 from the request property oneOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property instructions list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property metadata list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property temperature list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property tools/items/oneOf[subschema #3: Function tool]/function/strict list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property top_p list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response property's maxLength was unset from 512 for the response status

    • breaking

      the response property's maxLength was unset from 256000 for the response status

    • breaking

      the response property's maxLength was unset from 256 for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      endpoint deprecated

    • info

      added the new optional request property

    • info

      added to the request property anyOf list

    • info

      added subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      the request property default value false was removed

    • info

      the request property default value 1 was removed

    • info

      the request property default value 1 was removed

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property //// list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value 1 was removed for the status

    • info

      the response's property default value 1 was removed for the status

    • info

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