Quickstart
Last updated

Quick Start

Using the Compass Context API Endpoint

Welcome to the quick start guide for Blackbird AI API. This guide will walk you through the steps needed to start using the API to analyze and gain insights into the context of claims, narratives, or content.

Step 1: Get Your API Client ID and Client Secret

To begin, you need an API Client ID and Client Secret to authenticate your requests.

  1. Sign up or log in to your Blackbird AI account.
  2. Received a Client ID and Client Secret
  3. Authenticate using our Authentication guide
  4. Store your Client ID and Client Secret securely.

Step 2: Set Up Your Environment

You can interact with the Compass Context API using any HTTP client, such as cURL, Postman, the OpenAPI Spec, or your preferred programming language (e.g., Python, JavaScript).

Example: Setting Up in cURL

curl -X POST https://api.blackbird.ai/compass/contextChecks \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "input": "Vaccines cause autism.",
      }'

Example: Setting Up in Python

import requests

url = "https://api.blackbird.ai/compass/contextChecks"
headers = {
    "Authorization": "Bearer <access_token>",
    "Content-Type": "application/json"
}
data = {
    "input": "Vaccines cause autism.",
}
response = requests.post(url, json=data, headers=headers)

print(response.json())

Step 3: Making Your First Request

Call one of our many API endpoints to send a claim and retrieve your claim's results.

Step 4: Explore Further

Now that you've made your first request, you can explore further by:

  • Adjusting the context field to add more relevant data or details.
  • Testing the API with different claims or content.
  • Integrating the API into your application or workflow to automate content analysis.

Support

For any issues or questions, please visit our documentation page or reach out to our support team at support@blackbird.ai.

Now you're all set to start analyzing the context of claims and narratives with Blackbird AI's Compass Context API!

 
Next page