GEThttps://core-api.heysadie.ai/assistants/{id}
id success data name firstMessage voiceId transcriberId modelId developerPrompt parameters recordingEnabled failoverNumber failoverMode phoneNumberId createdAt updatedAt toolIds timezone address endOfCallMessage phoneNumberPassThrough summaryPrompt structuredDataPrompt categories promptId chatPromptId whisperSummaryPromptId backgroundSound serverUrl csatFeedback notifications idleMessages transferMode callTimeLimitSeconds idleTimeoutSeconds idleMessageMaxSpokenCount settings taskDrivenMode featureFlags ivrSettings metadata timestamp version path error code message details fieldGet assistant
Try it in the API ExplorerExample request
Terminal
curl "https://core-api.heysadie.ai/assistants/ASSISTANT_ID" \
-H "Authorization: ApiKey YOUR_API_KEY"Authentication
Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.
AuthorizationstringrequiredAPI key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.
X-Tenant-Idstring (uuid)optionalRequired when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.
Request
Path parameters
idstringrequiredThe resource's UUID.
Responses
200
successbooleanrequireddataobjectoptionalShow 38 child properties
idstringrequirednamestringrequiredfirstMessagestringrequiredvoiceIdstring | nullrequiredtranscriberIdstring | nullrequiredmodelIdstring | nullrequireddeveloperPromptstring | nullrequiredparametersanyrequiredrecordingEnabledbooleanrequiredfailoverNumberstring | nullrequiredfailoverModebooleanrequiredphoneNumberIdstring | nullrequiredcreatedAtstring (date-time) | string (date) | number | nullrequiredupdatedAtstring (date-time) | string (date) | number | nullrequiredtoolIdsstring[] | nullrequiredtimezonestringrequiredaddressstring | nullrequiredendOfCallMessagestring | nullrequiredphoneNumberPassThroughbooleanrequiredsummaryPromptstring | nullrequiredstructuredDataPromptstring | nullrequiredcategoriesstring[] | nullrequiredpromptIdstring | nullrequiredchatPromptIdstring | nulloptionalwhisperSummaryPromptIdstring | nulloptionalbackgroundSoundbooleanrequiredserverUrlstring | nullrequiredcsatFeedbackbooleanrequirednotificationsanyrequiredidleMessagesanyrequiredtransferModeanyrequiredcallTimeLimitSecondsnumber | nullrequiredidleTimeoutSecondsnumber | nullrequiredidleMessageMaxSpokenCountnumber | nullrequiredsettingsany | nullrequiredtaskDrivenModeboolean | nulloptionalfeatureFlagsmap<string, boolean>optionalivrSettingsany | nulloptionalmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional400
successbooleanrequirederrorobjectoptionalShow 3 child properties
codeenumrequiredAllowed values:
"VALIDATION_ERROR"messagestringrequireddetailsobject[]optionalShow 2 item properties
fieldstringrequiredmessagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional401
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"UNAUTHORIZED"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional403
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"FORBIDDEN"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional404
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"RESOURCE_NOT_FOUND"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional500
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"INTERNAL_SERVER_ERROR"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional