Update Web Agent Settings
Update your web agent’s settings, prompt and other details.
Headers
Your API key for authentication.
Path Parameters
The web agent you’ll be updating.
Body
Provide instructions, relevant information, and examples of the ideal conversation flow.
Best Practices
Best Practices
Out-of-the-Box Behaviors (Summarized):
- Speech pattern: Direct, concise, casual
- Spells out symbols, acronyms, abbreviations, percentages, etc. ($4,000,000 -> “four million dollars”)
- Asks clarifying questions
Prompting Tips:
- Want to easily test out exactly how your agent will behave?
- Aim for less than >2,000 characters where possible.
- Simple, direct prompts are the most predictable and reliable.
- Frame instructions positively:
"Do this"
rather than"Don't do this"
.- Ex. “Keep the conversation casual” rather than “Don’t be too formal”.
- This gives concrete examples of what to do, instead of leaving expected behavior open to interpretation.
Set your agent’s voice - all available voices can be found with the List Voices endpoint.
Set a webhook URL to receive call data after the web call completes.
Define a JSON schema for how you want to get information about the call - information like email addresses, names, appointment times or any other type of custom data.
In the webhook response or whenever you retrieve call data later, you’ll get the data you defined back under analysis
.
For example, if you wanted to retrieve this information from the call:
You would get it filled out like this in your webhook once the call completes:
Add any additional information you want to associate with the call. This can be useful for tracking or categorizing calls.
Set the pathway that your agent will follow. This will override the prompt
field, so there is no need to pass the ‘prompt’ field if you are setting a pathway.
Warning: Setting a pathway will set the following fields to null
/ their default value - prompt
, first_sentence
, model
, dynamic_data
, tools
, transfer_list
Set to null
or an empty string to clear the pathway.
Select a supported language of your choice. Optimizes every part of our API for that language - transcription, speech, and other inner workings.
Supported Languages and their codes can be found here.
The webhook should be a http / https callback url. We will send the call_id and transcript to this URL after the call completes. This can be useful if you want to have real time notifications when calls finish.
Set to null
or an empty string to clear the webhook.
Select a model to use for your call.
Options: base
or turbo
.
In nearly all cases, base
is the best choice for now.
Model Differences
Model Differences
There are two different ways to use Bland:
-
model: base
- The original, follows scripts/procedures most effectively.
- Supports all features and capabilities.
- Best for Custom Tools
-
model: turbo
- The absolute fastest latency possible, can be verbose at times
- Limited capabilities currently (excludes Transferring, IVR navigation, Custom Tools)
- Extremely realistic conversation capabilities
A phrase that your call will start with instead of a generating one on the fly. This works both with and without wait_for_greeting
. Can be more than one sentence, but must be less than 200 characters.
To remove, set to null
or an empty string.
Interact with the real world through API calls.
Detailed tutorial here: Custom Tools
Integrate data from external APIs into your agent’s knowledge.
Set to null
or an empty string to clear dynamic data settings.
Detailed usage in the Send Call endpoint.
Adjusts how patient the AI is when waiting for the user to finish speaking.
Lower values mean the AI will respond more quickly, while higher values mean the AI will wait longer before responding.
Recommended range: 50-200
- 50: Extremely quick, back and forth conversation
- 100: Balanced to respond at a natural pace
- 200: Very patient, allows for long pauses and interruptions. Ideal for collecting detailed information.
Try to start with 100 and make small adjustments in increments of ~10 as needed for your use case.
The maximum duration that calls to your agent can last before being automatically terminated.
Set to null
to reset to default.
Response
Whether the update was successful or not - will be success
or error
.
A message describing the status of the update.
An object containing the updated settings for the agent.
If the update was unsuccessful, this will contain the settings that failed to update. Useful to determine how your request is being interpreted on our end.