WIwithallo
AI Receptionist

Set the AI receptionist prompt

Changed on

Replaces the receptionist's prompt: what it is trying to achieve, who it is, how it handles the call. A prompt is only valid whole, so read the current sections with GET /v2/api/numbers/{number}/agent and send them all back, including the ones you are not changing. Facts about the business belong in knowledge, not here.

put/v2/api/numbers/{number}/agent/prompt

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/numbers/{number}/agent/prompt
  • Auth
    API key in header Authorization

Path parameters

numberstring required
Example:+14155551234

Allo phone number in E.164 format

Request body

Example request

{
  "sections": [
    {
      "fields": [
        {
          "label": "Email",
          "question": "What is the best email to send the quote to?",
          "complete_when": "a valid email address is given"
        }
      ]
    }
  ]
}

Response

The prompt after the write, with server-derived titles

Example response

{
  "data": {
    "sections": [
      {
        "title": "Objective",
        "content": "Book a visit with the caller.",
        "fields": [
          {
            "label": "Email",
            "question": "What is the best email to send the quote to?",
            "complete_when": "a valid email address is given"
          }
        ]
      }
    ]
  }
}

Changes