POST
/
v1
/
sms
/
analyze
curl --request POST \
  --url https://api.bland.ai/v1/sms/analyze \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "goal": "<string>",
  "answers": [
    {}
  ],
  "to": "<string>",
  "from": "<string>"
}'
{
    "status": "success",
    "message": "Successfully analyzed SMS messages.",
    "answers": [
        "Bob prefers to have movers come in the morning.",
        "..."
    ]
}

Headers

authorization
string
required

Your API key for authentication.

Body

goal
string
required

An overarching goal for the information you want to extract from the SMS messages.

answers
array
required

An array of questions that you want the AI to answer, along with their return types.

For example:

{
    "answers": [
        [ "When does Bob want to move?", "time" ],
        [ "Summarize the call.", "summary" ]
    ]
}
to
string
required

The phone number that received the messages.

from
string
required

The human/other phone number in the conversation.