Bird · Example Payload

Bird Predict Intent Example

Example of a POST request to /api/v1/datasets/{datasetId}/predict to classify an incoming phrase.

CommunicationsSMSEmailWhatsAppVoiceMessagingOmnichannelCustomer Engagement

Bird Predict Intent Example is an example object payload from Bird, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

{
  "summary": "Predict an intent for a customer phrase using Bird Intent API",
  "description": "Example of a POST request to /api/v1/datasets/{datasetId}/predict to classify an incoming phrase.",
  "request": {
    "method": "POST",
    "url": "https://intent.messagebird.com/api/v1/datasets/dde4eeae-7652-4bc8-8be1-1cd6ac898dc7/predict",
    "headers": {
      "Authorization": "AccessKey YOUR_ACCESS_KEY",
      "Content-Type": "application/json"
    },
    "body": {
      "phrase": "I'd like to order something"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "intent": "order",
      "intentPredicted": true
    }
  }
}