Quickstart

This guide will help you set up and get ready to use the Bodyguard.ai API. We will cover how to get started and make your first API request, as well as direct you to all the information you need to take full advantage of our powerful API.

Making your first API request

Once you have selected your preferred programming language and HTTP client, you can make your first call to the Bodyguard.ai API. Below, you will find examples on how to send a POST request to the Analyze endpoint in order to create a simple message analysis.

curl --request POST 'https://bamboo.bodyguard.ai/api/analyze' \
     --header 'X-Api-Key: __YOUR_API_KEY__' \
     --header 'Content-Type: application/json' \
     --data-raw '{
       "channelId": "__YOUR_CHANNEL_ID__",
       "contents": [
           {
               "text": "Einstein is an asshole",
               "publishedAt": "2022-10-07T11:34:26.312Z"
           }
       ]
   }'

{
	"data": [
		{
			"text": "Einstein is an asshole",
			"reference": "bodyguard/fc9dec31-695d-47cc-b919-68dd711bd607",
			"type": "HATEFUL",
			"severity": "HIGH",
			"recommendedAction": "REMOVE",
			"meta": {
				"directedAt": "SINGLE_PERSON",
				"classifications": ["INSULT"]
			},
			"language": "en",
			"analyzedAt": "2022-10-07T11:34:29.873Z",
			"publishedAt": "2022-10-07T11:34:26.312Z"
		}
	]
}

What's next?

Great, you're now set up with an API client and have made your first request to the Bodyguard.ai API. Its power allows you to get more than a simple analysis. There is so much to discover, from batch messages to contextual information (authors, posts, etc).

Here are a few links that might be handy as you venture further into the Bodyguard.ai API:

• Learn about Bodyguard.ai taxonomy used in terms of moderation
• Check out the Analyze endpoint
• Know more about webhooks