Create an assistant with a model and instructions. An assistant can call models and use tools to perform tasks.

External Documentation

To learn more, visit the OpenAI documentation.

​
Basic Parameters

ParameterDescription
Assistant NameThe name of the assistant.
InstructionsThe system instructions that the assistant uses.For example: “You are a personal math tutor. When asked a question, write and run Python code to answer the question.”.
ModelThe model to use. You can use the List models action to get all of your available models, or visit OpenAI’s Model Overview for descriptions of them.

​
Advanced Parameters

ParameterDescription
MetadataSet of key-value pairs that can be attached to an object.Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
Response FormatSpecifies 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.For more information regarding models refer to OpenAI’s Documentation.
TemperatureWhat 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.
Tool ResourcesA set of resources that are used by the assistant’s tools.Valid format:json{ "{tool1}": { "file_ids": [{file_id1}, {file_id2}], }, "{tool2}": { "file_ids": [{file_id3}, {file_id4}], },}For more information refer to OpenAI’s Documentation.
ToolsA list of tools enabled on the assistant.Valid format: [ { "type": "code_interpreter" }, { "type": "file_search" } ]For more information about the tools parameter, visit OpenAI API documentation.

​
Example Output

{
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1698984975,
  "name": "Math Tutor",
  "description": null,
  "model": "gpt-4-turbo",
  "instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
  "tools": [
    {
      "type": "code_interpreter"
    }
  ],
  "metadata": {},
  "top_p": 1.0,
  "temperature": 1.0,aj
  "response_format": "auto"
}

​
Workflow Library Example

Create Assistant with Openai and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

OverviewCreate Chat Completion