🤖 Assistants Official Documentation

â‹™ Create Assistant

Create an assistant with a model and instructions.

msg.payload Properties

model string
ID of the model to use.
name string
The name of the assistant.
description string
The description of the assistant.
instructions string
The system instructions that the assistant uses.
tools array
A list of tool enabled on the assistant.
tool_resources object
A set of resources that are used by the assistant's tools.
metadata object
Set of 16 key-value pairs that can be attached to an object.
temperature number
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_p number
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
response_format string
Specifies the format that the model must output.

â‹™ Retrieve Assistant

Retrieves an assistant.

msg.payload Properties

assistant_id string
The ID of the assistant to retrieve.

â‹™ Modify Assistant

Modifies an assistant.

msg.payload Properties

assistant_id string
The ID of the assistant to retrieve.
model string
ID of the model to use.
name string
The name of the assistant.
description string
The description of the assistant.
instructions string
The system instructions that the assistant uses.
tools array
A list of tool enabled on the assistant.
tool_resources object
A set of resources that are used by the assistant's tools.
metadata object
Set of 16 key-value pairs that can be attached to an object.
temperature number
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_p number
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
response_format string
Specifies the format that the model must output.

â‹™ Delete Assistant

Delete an assistant.

msg.payload Properties

assistant_id string
The ID of the assistant to delete.

â‹™ List Assistants

Returns a list of assistants.

msg.payload Properties

limit integer
A limit on the number of objects to be returned.
order string
Sort order by the created_at timestamp of the objects.
after string
A cursor for use in pagination.
before string
A cursor for use in pagination.

â‹™ List Assistant Files

Returns a list of assistant files.

msg.payload Properties

assistant_id string
The ID of the assistant the file belongs to.
limit integer
A limit on the number of objects to be returned.
order string
Sort order by the created_at timestamp of the objects.
after string
A cursor for use in pagination.
before string
A cursor for use in pagination.

â‹™ Create Assistant File

Create an assistant file by attaching a file to an assistant.

msg.payload Properties

assistant_id string
The ID of the assistant for which to create a File.
file_id string
A File ID (with purpose="assistants") that the assistant should use.

â‹™ Retrieve Assistant File

Retrieves an AssistantFile.

msg.payload Properties

assistant_id string
The ID of the assistant who the file belongs to.
file_id string
The ID of the file we're getting.

â‹™ Delete Assistant File

Delete an assistant file.

msg.payload Properties

assistant_id string
The ID of the assistant that the file belongs to.
file_id string
The ID of the file to delete.