Update an assistant
Changes the fields you send and keeps the others.
PATCH/v1/assistants/{assistant_id}
Requires assistants:write.
Only the fields you send change. resource_ids and follow_tags replace the previous lists, and the list of a mode you are not using is kept, so you can switch back later.
The next question uses the new settings.
A PATCH is not retried by the CLI after a server error. Read the assistant before you try again.
Authorizations
Authorizationbearerin headerrequiredPath parameters
assistant_idstringrequiredpattern: ^ast_[abcdefghjkmnpqrstuvwxyz23456789]{12}$Body
application/jsonrequirednamestringlength: 1–120 charscontextstringlength: ≤ 12000 charsWhat the assistant is and who it talks to: its role and its audience.
output_guidelinesstringlength: ≤ 12000 charsHow answers are written: length, format, language.
resource_idsstring[]items: ≤ 200 itemsThe resources it answers from.
follow_tagsstring[]items: ≤ 30 itemsTags it follows when knowledge is tags: every resource carrying one, now or later, is used (one knowledge mode applies at a time).
knowledgeenum<string>one of: all, selected, tagsWhat the assistant reads: all is every resource of the workspace, now and later; selected is only resource_ids; tags is every resource carrying a tag in follow_tags, now or later. One mode at a time; the lists of the other modes are kept.
Response
Update an assistant
dataobjectrequiredrequest_idstringrequiredPossible codes: invalid_request, unknown_field, invalid_parameter, invalid_cursor
errorobjectrequiredrequest_idstringrequiredPossible codes: authentication_required, invalid_api_key, api_key_expired, api_key_revoked, invalid_access_key
errorobjectrequiredrequest_idstringrequiredPossible codes: insufficient_scope, feature_not_available, admin_required, permission_denied
errorobjectrequiredrequest_idstringrequiredPossible codes: resource_not_found
errorobjectrequiredrequest_idstringrequiredPossible codes: request_too_large
errorobjectrequiredrequest_idstringrequiredPossible codes: rate_limited
errorobjectrequiredrequest_idstringrequiredPossible codes: internal_error
errorobjectrequiredrequest_idstringrequired