assistants
Update Assistant
Update an assistant.
put/api/assistants/{assistant_id}
Path parameters
assistant_idstring uuid required
Request body
model'gpt-4o'
instructionsstring nullable
knowledge_base_idstring uuid nullable required
context_limitinteger nullable
The maximum number of context chunks to include in a run.
codex_access_keystring nullable
codex_as_cacheboolean
namestring required
The name of the assistant
descriptionstring required
The description of the assistant
url_slugstring nullable
Optional URL suffix - unique identifier for the assistant's endpoint
suggested_questionsstring[]
A list of suggested questions that can be asked to the assistant
logo_s3_keystring nullable
S3 object key to the assistant's logo image
logo_textstring nullable
Text to display alongside the assistant's logo
idstring uuid required
Response
Successful Response
model'gpt-4o'
instructionsstring nullable
knowledge_base_idstring uuid nullable required
context_limitinteger nullable
The maximum number of context chunks to include in a run.
codex_access_keystring nullable
codex_as_cacheboolean
namestring required
The name of the assistant
descriptionstring required
The description of the assistant
url_slugstring nullable
Optional URL suffix - unique identifier for the assistant's endpoint
suggested_questionsstring[]
A list of suggested questions that can be asked to the assistant
logo_s3_keystring nullable
S3 object key to the assistant's logo image
logo_textstring nullable
Text to display alongside the assistant's logo
idstring uuid required
created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable required