Assistants
An assistant represents an AI agent that can perform tasks, answer questions, and interact with users.
Assistants can be customized with models, instructions, functions, MCP servers.
Endpoints
Manage your assistants with these REST endpoints.
List assistantsRetrieve a list of assistants
Create assistantCreate a new assistant
Get assistantRetrieve a specific assistant
Update assistantUpdate an existing assistant
Delete assistantDelete an existing assistant
Assistant type
StorageProviderType
Possible values for
StorageProviderType are:OPENAIAZURE_OPENAISUPERINTERFACE_CLOUDStorage provider type defines where the assistant’s thread data and messages are stored.
It can either be an AI provider like OpenAI or Azure OpenAI, or stored in Superinterface Cloud.
If OpenAI or Azure OpenAI is used, Superinterface will not store thread messages - it
will only store references to OpenAI or Azure OpenAI threads.
Example assistant
const assistant = {
id: '00cfe680-fee5-49b9-b386-6a7097eb8497',
storageProviderType: 'OPENAI',
storageProviderAssistantId: 'asst_xwQudIsRPVWBOkanyBRWWBn2',
modelProviderId: '01afd9c6-519f-4336-a39e-e739143f0a5c',
model: 'gpt-4.1',
name: 'AI builder',
description: 'Builds applications',
instructions: 'Help user build apps.',
codeInterpreterEnabled: true,
fileSearchEnabled: false,
createdAt: '2024-01-15T10:30:00Z',
updatedAt: '2024-01-15T10:30:00Z',
}
PublicAssistant type
PublicAssistant is returned by endpoints that require a public API key. It only contains fields safe for client-side use.Example PublicAssistant
const publicAssistant = {
id: '00cfe680-fee5-49b9-b386-6a7097eb8497',
name: 'AI builder',
description: 'Builds applications',
theme: {
accentColor: 'blue',
grayColor: 'gray',
appearance: 'light',
radius: 'medium',
scaling: '100%',
panelBackground: 'solid',
},
avatar: {
type: 'ICON',
imageAvatar: null,
iconAvatar: {
name: 'LIGHTNING_BOLT',
},
},
}