Guides
Guides

Quickstart

Getting Started with the SeekrAlign API

The SeekrAlign API provides users with the ability to evaluate content for reliability, safety, and suitability at scale. Through our RESTful API, you can leverage cutting-edge AI technologies to assess and score web content, including news articles, websites, podcasts, authors, and episodes. SeekrAlign’s trusted AI models analyze content based on journalistic standards, cognitive biases, and other key factors, providing actionable insights tailored to various industries and use cases.

Endpoints are structured around specific content types, making it simple to integrate SeekrAlign into your workflows and applications.

Getting Started

To begin using the SeekrAlign API, follow these steps:

  1. Obtain Your API Key:
  1. Set Up Authentication:
  • Include your API key in the header of every request using the format:
   Authorization: Bearer <your_api_key>`
  1. Make Your First API Call:
  • Select an endpoint relevant to your use case, such as scoring a news article or retrieving podcast insights.

API Endpoints

API Reference

Explore the full API reference here: <https://docs.seekr.com/reference>

Base URL

https://services-api.seekr.com/

Authentication

All requests to the SeekrAlign API must include an API key for authentication.

Header Format:

Authorization: Bearer <your_api_key>

List of Podcast API endpoints:

  1. Fetch Podcast Information

Purpose: General search across all podcasts.
Scope: Broad, includes filtering by civility scores, genres, and titles for multiple podcasts.
Result: Returns a list of podcasts matching the criteria.

  1. Fetch Podcast Details

Purpose: Detailed information about one specific podcast.
Scope: Focused on metadata for a single podcast.
Result: Provides deep insights like authors, description, and civility score for a specific podcast.

  1. Fetch Episodes from a Podcast

Purpose: Retrieve all episodes of a specific podcast.
Scope: Narrow, tied to a single podcast ID.
Result: Lists episodes with their basic metadata, filtered by parameters like explicit content or civility score.

  1. Fetch Episode Details

Purpose: Focused details about one specific episode.
Scope: Targeted at a single podcast episode ID.
Result: Provides episode-specific metadata like duration, title, and civility analysis.

  1. Fetch Episode Transcript

Purpose: Retrieves the full transcript of a specific podcast episode.
Scope: Transcript-level granularity.
Result: Includes civility levels, speaker info, and timestamps for segments.

  1. Fetch Podcast Episodes

Purpose: Search for episodes across all podcasts.
Scope: Global, spans all podcasts rather than a single podcast.
Result: Lists episodes meeting specified criteria like civility score or publication dates, independent of a specific podcast.

Response Format

Responses are returned in JSON format, providing:

  • Seekr Scores for content reliability.
  • Metadata and scoring factors such as clickbait, subjectivity, and more.
  • Political lean data when applicable.

Example Request

curl --request GET \
     --url https://services-api.seekr.com/api/v1/podcasts \
     --header 'accept: application/json' \
     --header 'authorization: Bearer xxxxxx'

Example Response

{
  "apiVersion": "1.0.0",
  "count": 1,
  "status": 200,
  "lastUpdated": "2023-09-19",
  "requestUrl": "string",
  "results": [
      ],
}

Example Bad Response

{
  "apiVersion": "1.23.0",
  "message": "The Authorization header must contain a valid bearer token.",
  "error": "Unauthorized",
  "requestUrl": "https://services-api.seekr.com/api/v1/podcasts",
  "status": "401"
}

Use Case Examples

Example 1: Scoring a Single News Article

Objective: Evaluate the reliability of a specific news article before sharing it.

Steps:

  1. Submit the URL of the article to the /news endpoint.
  2. Review the response for the Seekr Score, scoring factors, and political lean data.

Result: Gain actionable insights into the article’s trustworthiness and alignment with journalistic standards.

Example 2: Assessing Podcast Episode Safety

Objective: Determine the suitability of a podcast episode for brand advertising.

Steps:

  1. Use the /podcasts/episodes endpoint to retrieve episode details.
  2. Analyze the Seekr Score and associated safety factors.

Result: Ensure the episode aligns with brand safety requirements.

Best Practices

  • Validate input URLs before submitting requests.
  • Test API integrations in a development environment before deployment.

For further details and advanced configurations, visit the SeekrAlign API Documentation.

Updated 3 days ago