assistants_create_assistant_request {oaii}

API assistants: create assistant

Description

Create an assistant with a model and instructions. To get more details, visit https://platform.openai.com/docs/api-reference/assistants/createAssistant https://platform.openai.com/docs/assistants

Usage

assistants_create_assistant_request(
  model,
  name = NULL,
  description = NULL,
  instructions = NULL,
  tools = NULL,
  file_ids = NULL,
  metadata = NULL,
  api_key = api_get_key()
)

Arguments

model

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

name

NULL/string, the name of the assistant. The maximum length is 256 characters.

description

NULL/string, the description of the assistant. The maximum length is 512 characters.

instructions

NULL/string, the system instructions that the assistant uses. The maximum length is 32768 characters.

tools

NULL/list, 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, retrieval, or function.

file_ids

NULL/character vector, a list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

metadata

NULL/list, 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.

api_key

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

Value

content of the httr response object or SimpleError (conditions) enhanced with two additional fields: 'status_code' (response$status_code) and 'message_long' (built on response content)