Update an assistant

Update the details of an existing assistant.

Request

PATCH https://superinterface.ai/api/cloud/assistants/{assistantId}

Authentication

Include your private API key in the request headers:

Authorization: Bearer YOUR_PRIVATE_API_KEY

Path Parameters

Parameter	Type	Description
`assistantId`	string	The ID of an existing assistant to update

Request Body

Parameter	Type	Required	Description
`storageProviderType`	`StorageProviderType`	No	New `StorageProviderType` (e.g., `OPENAI`)
`storageProviderAssistantId`	string	No	New storage provider assistant ID
`modelProviderId`	string	No	New model provider ID
`model`	string	No	New model to use (e.g., "gpt-4.1")
`name`	string	No	A new name for the assistant
`description`	string	No	A new description for the assistant
`instructions`	string	No	New instructions for the assistant
`codeInterpreterEnabled`	boolean	No	Enable or disable code interpreter
`fileSearchEnabled`	boolean	No	Enable or disable file search

Example request

curl -X PATCH "https://superinterface.ai/api/cloud/assistants/00cfe680-fee5-49b9-b386-6a7097eb8497" \ -H "Authorization: Bearer YOUR_PRIVATE_API_KEY" \ -H "Content-Type: application/json" -d '{ "name": "Updated AI builder" }'

Response

Parameter	Type	Description
`assistant`	Assistant	Updated Assistant

Example response

{ "assistant": { "id": "00cfe680-fee5-49b9-b386-6a7097eb8497", "storageProviderType": "OPENAI", "storageProviderAssistantId": "asst_xwQudIsRPVWBOkanyBRWWBn2", "modelProviderId": "01afd9c6-519f-4336-a39e-e739143f0a5c", "model": "gpt-4.1", "name": "Updated AI builder", "description": "Builds applications", "instructions": "Help user build apps.", "codeInterpreterEnabled": true, "fileSearchEnabled": true, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-16T12:00:00Z" } }

Errors

The endpoint may return the following errors:

401 Unauthorized

This error occurs if the API key is invalid or missing.

{ "error": "Unauthorized", "message": "Invalid or missing API key" }