Update an assistant
Partial update - only included fields are changed. phone_number and
carrier are read-only and cannot be updated via this endpoint.
Cross-resource refs are validated to belong to your organization.
When introduction is included, the successful response confirms that
the new opening text has been committed to the active assistant
configuration used by the dashboard and by newly initialized calls.
Existing localized translations are regenerated asynchronously;
already initialized or in-progress calls keep the configuration they
loaded earlier.
bearerAuthAuthorizationBearer <token>API key in the Authorization: Bearer <key> header.
Keys are created in the Hallolara dashboard (Settings → API Keys).
assistant_id*string^[a-f0-9]{24}$application/json- body
Partial update - include only the fields you want to change.
1 <= propertiesname?string1 <= length <= 100description?stringlength <= 500language?string"de""en""fr""it""de-CH""es""pt""tr""sv""fi""nl"voice_id?stringVoice ID. Use a value returned by GET /voices. An existing legacy ID may remain unchanged, but changing to a legacy, unknown, or unavailable ID returns 400.
company_name?string1 <= length <= 200company_industry?string1 <= length <= 200introduction?stringReplaces the opening greeting. If language is omitted, the greeting keeps its current language. Existing translations are removed and regenerated in the background; until then they may be missing.
1 <= length <= 5000record_call?booleanspeed?numberVoice playback rate multiplier. Some voices only support 0.8–1.2; out-of-range values for such voices return 400.
0.7 <= value <= 1.2tts_style_level?numberVoice style level from 0 (calm) to 1 (expressive).
0.010 <= value <= 1background_ambience?stringBackground ambience bed mixed under the assistant voice during phone calls.
"clean""office""restaurant"appointment_booking_enabled?booleancontextual_asr_correction_enabled?booleanPer-turn LLM correction of misrecognised proper nouns (names, companies, products) in caller transcripts, using the assistant's own contacts, employees, glossary and knowledge. Adds latency on turns that carry a candidate. Default false.
allow_preferred_language?booleanwhitelist?booleanprompt_id?|^[a-f0-9]{24}$outbound_prompt_id?|Prompt for outbound calls. null (the default) means outbound calls use prompt_id.
^[a-f0-9]{24}$knowledge_group_ids?array<>glossary_group_ids?array<>pronunciation_group_ids?array<>forwarding_group_ids?array<>contact_group_ids?array<>calendar_ids?array<>items <= 1tool_ids?array<>Webhook-type tools only. Integration-type / internal tools cannot be referenced via the public API and will return 404 on create/update.
analysis_ids?array<>Replaces the call analyses run on this assistant's calls. Adding an
analysis whose flow contains the delete-call node, which deletes
each call it runs on, requires the API key's role to grant
call_logs.call_data delete (call_logs.call_recording delete
when the node deletes only the recording); adding one whose flow contains the
start-call node, which places an outbound call after each call it
runs on, requires assistants.triggerOutbound post. Otherwise the
request returns 403 forbidden and nothing is changed. Analyses the
assistant already runs, and removing one, need no such grant. An MCP
connection never adds an analysis with the start-call node.
pre_call_webhook?|Optional lookup that supplies caller context from your endpoint at the
start of inbound and outbound calls. Add @preCallData to the assistant's
assigned prompt to use the response. Saving this object does not call the
endpoint or edit the prompt.
Every supplied object requires enabled. When true, include a nonempty
HTTPS url in the same request, even if a URL is already stored. String
input limits count Unicode characters.
On creation or first configuration, omitted fields default to POST, empty
headers and body template, no authentication, and a 5000 ms timeout.
Omit pre_call_webhook or send null on creation to leave it unconfigured.
On PATCH, omit pre_call_webhook to preserve it, or send null to remove
the configuration and credentials. A supplied object merges with the
stored configuration; omitted nested fields retain their values, except
that changing url requires the stored credential again (see auth).
{ "enabled": false } disables execution while retaining the configuration
and credentials. See headers and auth for their replacement rules.
A concurrent clear,
auth-state change, or URL change of a webhook with a stored credential can
return 409 without applying any part of the PATCH; fetch the latest
assistant before retrying.
The endpoint must return a successful (2xx) response containing JSON or
text, up to 256 KiB. JSON is serialized to text for @preCallData; the
injected text is limited to 4000 characters. Execution runs in the
background without retries. Disabled, failed, timed-out or busy requests
contribute an empty value. Prompt rendering waits at most 400 ms once
per call; a later response can be used on later turns.
Updated assistant.
application/json- response
data?curl -X PATCH 'https://api.hallolara.ai/api/v1/assistants/65f8fa6f1a9d8e0012ab34cd' \ -H 'Content-Type: application/json' \ -d '{ "description": "Handles first-line customer support calls."}'{ "data": { "id": "string", "name": "string", "description": "string", "language": "de", "voice_id": "string", "record_call": true, "speed": 0.7, "tts_style_level": 0, "background_ambience": "clean", "appointment_booking_enabled": true, "contextual_asr_correction_enabled": true, "allow_preferred_language": true, "whitelist": true, "introduction": "string", "company_name": "string", "company_industry": "string", "phone_number": "string", "carrier": "string", "prompt_id": "string", "outbound_prompt_id": "string", "email_prompt_id": "string", "knowledge_group_ids": [ "string" ], "glossary_group_ids": [ "string" ], "pronunciation_group_ids": [ "string" ], "forwarding_group_ids": [ "string" ], "contact_group_ids": [ "string" ], "calendar_ids": [ "string" ], "tool_ids": [ "string" ], "analysis_ids": [ "string" ], "pre_call_webhook": { "enabled": true, "url": "string", "method": "GET", "headers": { "property1": "string", "property2": "string" }, "body_template": "string", "timeout_ms": 500, "auth": { "type": "none", "header_name": "string", "username": "string" } }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}Get an assistant GET
Returns the configuration of an assistant in your organization.
Delete an assistant DELETE
Fails with `409 conflict` while the assistant is in use: a website widget references it, an open chat is answered by it, one of its calls is still running, or a start-call node in one of the organization's analyses places its calls with it (the message names those analyses). Enterprise assistants, and lines managed for you by the platform, cannot be deleted at all and always answer `409 conflict`.