Get an assistant
Get the details of an existing assistant.
Request
GET https://superinterface.ai/api/cloud/assistants/{assistantId}?publicApiKey={publicApiKey}
Query Parameters
Path Parameters
Example request
curl -X GET "https://superinterface.ai/api/cloud/assistants/00cfe680-fee5-49b9-b386-6a7097eb8497?publicApiKey=40cfe680-fee5-49b9-b386-6a7097eb8497" \
-H "Content-Type: application/json"
Response
Example response
{
"assistant": {
"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"
}
}
}
}
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"
}