Skip to content

index.mdx

Latest commit

 

History

History
77 lines (50 loc) · 2.77 KB

index.mdx

File metadata and controls

77 lines (50 loc) · 2.77 KB
title Introduction
description Welcome to the Supadata documentation. Our API provides powerful tools for extracting web content.
og:title Getting Started | Supadata
og:description Supadata is a web to text API that allows you to extract text from websites and YouTube videos.

Overview

Supadata offers four main services:

  • Video Transcripts - Extract transcripts from YouTube, TikTok, Instagram, Facebook, X (Twitter) and video files
  • Media Metadata - Get social media post data like title, author and engagement metrics
  • Structured Data Extraction - Use AI to extract structured data from videos across all supported platforms
  • Web Reader - Extract content from any website, crawl pages and extract structured data
  • YouTube Metadata - Extract video, channel and playlist metadata

Getting an API Key

All requests to Supadata require authentication using an API key. The same key also works with the SDKs and no-code integrations. To get your API key:

  1. Sign up for an account at dash.supadata.ai
  2. Your API key will be generated automatically during onboarding and available in the dashboard

Integrations and SDKs

This documentation provides examples for how to use the Supadata API and its various parameters.

We also offer the following SDKs and integrations:

Documentation for AI

If you're working with an AI assistant or vibe coding, we recommend using the "Copy Page" dropdown in top right corner of each page to get AI-ready documentation. Alternatively, give your assistant links to llms.txt or llms-full.txt.

Rate Limits

API requests are rate-limited based on your subscription plan. Current limits are shown on the pricing page.

It is possible to increase rate limits upon request.

API Usage

Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

curl -H "x-api-key: YOUR_API_KEY" https://api.supadata.ai/v1/...
Never share your API key or commit it to version control. Use environment variables to store your API key securely. Only access the API from a secure server environment.

Base URL

All API endpoints use the following base URL:

https://api.supadata.ai/v1

Response Format

All API responses are returned in JSON format.

Community Resources

The Supadata community has created various resources and guides for using Supadata. You can find them here.