Retrieves an assistant.

GET /assistants/{assistant_id}

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:
      Hide attribute Show attribute
      • type string Required

        The type of tool being defined: code_interpreter

        Value is code_interpreter.

    • 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).

    • 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, 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.

      Hide metadata attribute Show metadata attribute object | null
      • * string Additional properties
    • 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

      Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

      Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

      Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

      Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

      One of:

      auto is the default value

      Value is auto.

GET /assistants/{assistant_id}
curl \
 --request GET 'https://api.openai.com/v1/assistants/{assistant_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "id": "string",
  "object": "assistant",
  "created_at": 42,
  "name": "string",
  "description": "string",
  "model": "string",
  "instructions": "string",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": []
    },
    "file_search": {
      "vector_store_ids": [
        "string"
      ]
    }
  },
  "metadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "temperature": 1,
  "top_p": 1,
  "response_format": "auto"
}