Path parameters

• assistant_id string Required

  The ID of the assistant to retrieve.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id string Required

    The identifier, which can be referenced in API endpoints.

  • object string Required

    The object type, which is always assistant.

    Value is assistant.

  • created_at integer Required

    The Unix timestamp (in seconds) for when the assistant was created.

  • name string | null Required

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

    Maximum length is 256.

  • description string | null Required

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

    Maximum length is 512.

  • model string 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.

  • instructions string | null Required

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

    Maximum length is 256000.

  • tools array[object] Required

    A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

    Not more than 128 elements. Default value is [] (empty).

    One of:

    Code interpreter tool object FileSearch tool object Function tool object

    Hide attribute Show attribute

    • type string Required

      The type of tool being defined: code_interpreter

      Value is code_interpreter.

    Hide attributes Show attributes

    • type string Required

      The type of tool being defined: file_search

      Value is file_search.

    • file_search object

      Overrides for the file search tool.

      Hide file_search attribute Show file_search attribute object

      • max_num_results integer

        The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.

        Note that the file search tool may output fewer than max_num_results results. See the file search tool documentation for more information.

        Minimum value is 1, maximum value is 50.

    Hide attributes Show attributes

    • type string Required

      The type of tool being defined: function

      Value is function.

    • function object Required
      Hide function attributes Show function attributes object

      • description string

        A description of what the function does, used by the model to choose when and how to call the function.

      • name string Required

        The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

      • parameters object

        The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

        Omitting parameters defines a function with an empty parameter list.

        Hide parameters attribute Show parameters attribute object

        • Additional properties are allowed
  • tool_resources object | null

    A set of resources that are used by the assistant'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.

    Hide tool_resources attributes Show tool_resources attributes object | null

    • code_interpreter object
      Hide code_interpreter attribute Show code_interpreter attribute object

      • file_ids array[string]

        A list of file IDs made available to the code_interpreter` tool. There can be a maximum of 20 files associated with the tool.

        Not more than 20 elements. Default value is [] (empty).

    • file_search object
      Hide file_search attribute Show file_search attribute object

      • vector_store_ids array[string]

        The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.

        Not more than 1 element.

  • metadata object | null 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 maxium of 512 characters long.

  • temperature number | null

    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.

    Minimum value is 0, maximum value is 2. Default value is 1.

  • top_p number | null

    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.

    Minimum value is 0, maximum value is 1. Default value is 1.

  • response_format string | null | object

    One of:

    string-1 string | null AssistantsApiResponseFormat object | null

    auto is the default value

    Values are none or auto.

    An object describing the expected output of the model. If json_object only function type tools are allowed to be passed to the Run. If text the model can return text or any value needed.

    Hide attribute Show attribute

    • type string

      Must be one of text or json_object.

      Values are text or json_object. Default value is text.