Skip to main content

assistants

Creates, updates, deletes, gets or lists an assistants resource.

Overview​

Nameassistants
TypeResource
Idopenai.assistants.assistants

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe identifier, which can be referenced in API endpoints.
namestringThe name of the assistant. The maximum length is 256 characters.
created_atinteger (unixtime)The Unix timestamp (in seconds) for when the assistant was created.
descriptionstringThe description of the assistant. The maximum length is 512 characters.
instructionsstringThe system instructions that the assistant uses. The maximum length is 256,000 characters.
metadataobjectSet 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. (x-oaiTypeLabel: map)
modelstringID 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.
objectstringThe object type, which is always assistant. (assistant)
response_formatstringSpecifies 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. (auto) (title: Text)
temperaturenumberWhat 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_resourcesobjectA 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.
toolsarrayA 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.
top_pnumberAn 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.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectassistant_idopenai-organization, openai-project
listselectlimit, order, after, before, openai-organization, openai-project
createinsertmodelopenai-organization, openai-project
updateupdateassistant_idopenai-organization, openai-project
deletedeleteassistant_idopenai-organization, openai-project

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
assistant_idstringThe ID of the assistant to delete.
afterstringA cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
beforestringA cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Automatically applied from a SQL LIMIT clause - SELECT ... LIMIT 10 sends limit=10 on the wire. Setting it explicitly in a WHERE clause is not required.
openai-organizationstringOptionally scope the request to a specific organization (overrides the default associated with the API key). Addressable in SQL as openai_organization.
openai-projectstringOptionally scope the request to a specific project (overrides the default associated with the API key). Addressable in SQL as openai_project.
orderstringSort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

SELECT examples​

OK

SELECT
id,
name,
created_at,
description,
instructions,
metadata,
model,
object,
response_format,
temperature,
tool_resources,
tools,
top_p
FROM openai.assistants.assistants
WHERE assistant_id = '{{ assistant_id }}' -- required
AND "openai-organization" = '{{ openai-organization }}'
AND "openai-project" = '{{ openai-project }}'
;

INSERT examples​

No description available.

INSERT INTO openai.assistants.assistants (
model,
name,
description,
instructions,
reasoning_effort,
tools,
tool_resources,
metadata,
temperature,
top_p,
response_format,
"openai-organization",
"openai-project"
)
SELECT 
'{{ model }}' /* required */,
'{{ name }}',
'{{ description }}',
'{{ instructions }}',
'{{ reasoning_effort }}',
'{{ tools }}',
'{{ tool_resources }}',
'{{ metadata }}',
{{ temperature }},
{{ top_p }},
'{{ response_format }}',
'{{ openai-organization }}',
'{{ openai-project }}'
RETURNING
id,
name,
created_at,
description,
instructions,
metadata,
model,
object,
response_format,
temperature,
tool_resources,
tools,
top_p
;

UPDATE examples​

No description available.

UPDATE openai.assistants.assistants
SET 
model = '{{ model }}',
reasoning_effort = '{{ reasoning_effort }}',
name = '{{ name }}',
description = '{{ description }}',
instructions = '{{ instructions }}',
tools = '{{ tools }}',
tool_resources = '{{ tool_resources }}',
metadata = '{{ metadata }}',
temperature = {{ temperature }},
top_p = {{ top_p }},
response_format = '{{ response_format }}'
WHERE 
assistant_id = '{{ assistant_id }}' --required
AND "openai-organization" = '{{ openai-organization}}'
AND "openai-project" = '{{ openai-project}}'
RETURNING
id,
name,
created_at,
description,
instructions,
metadata,
model,
object,
response_format,
temperature,
tool_resources,
tools,
top_p;

DELETE examples​

No description available.

DELETE FROM openai.assistants.assistants
WHERE assistant_id = '{{ assistant_id }}' --required
AND "openai-organization" = '{{ openai-organization }}'
AND "openai-project" = '{{ openai-project }}'
;