Getting Started

Welcome to SocialKit! This guide will walk you through setting up and making your first API request. In just a few minutes, you’ll be able to analyze social media videos, extract summaries, and get transcripts using our API.

1. Get Your Access Key 🔑

To start using SocialKit, you’ll need an Access Token. Follow these steps:

Sign up at SocialKit Dashboard
Copy your Access Key from the project Access Keys tab.

You can attach your access key to requests in any of these ways:

GET parameter: access_key
POST parameter: access_key
Header: x-access-key

2. Make Your First API Request

Note: You can make requests using either GET or POST methods.

YouTube Video Summary

GET https://api.socialkit.dev/youtube/summarize?access_key=<your-access-key>&url=https://youtube.com/watch?v=dQw4w9WgXcQ

Response

{
	"success": true,
	"data": {
		"url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
		"summary": "The video features the song 'Never Gonna Give You Up' by Rick Astley, which expresses themes of love, commitment, and reassurance in a romantic relationship.",
		"mainTopics": [
			"Love",
			"Commitment",
			"Reassurance"
		],
		"keyPoints": [
			"The singer emphasizes unwavering commitment to a partner.",
			"The lyrics convey a sense of understanding and mutual feelings.",
			"The repetition of key phrases reinforces the message of loyalty."
		],
		"tone": "Uplifting and reassuring",
		"targetAudience": "Fans of 80s music and pop culture enthusiasts",
		"quotes": [
			"Never gonna give you up.",
			"Your heart's been aching but you're too shy to say it."
		],
		"timeline": "The song follows a structured verse-chorus format, alternating between expressions of commitment and emotional connection."
	}
}

YouTube Video Transcript

GET https://api.socialkit.dev/youtube/transcript?access_key=<your-access-key>&url=https://youtube.com/watch?v=dQw4w9WgXcQ

Response

{
	"success": true,
	"data": {
		"url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
		"transcript": "[♪♪♪] ♪ We're no strangers to love ♪ ♪ You know the rules\nand so do I ♪ ♪ A full commitment's\nwhat I'm thinking of ♪ ♪ You wouldn't get this\nfrom any other guy ♪ ♪ I just wanna tell you\nhow I'm feeling ♪ ♪ Gotta make you understand ♪ ♪ Never gonna give you up ♪ ♪ Never gonna let you down ♪ ♪ Never gonna run around\nand desert you ♪ ♪ Never gonna make you cry ♪ ♪ Never gonna say goodbye ♪ ♪ Never gonna tell a lie\nand hurt you ♪",
		"transcriptSegments": [
			{
				"text": "[♪♪♪]",
				"start": 0,
				"duration": 5,
				"timestamp": "00:00"
			},
			{
				"text": "♪ We're no strangers to love ♪",
				"start": 5,
				"duration": 5,
				"timestamp": "00:05"
			},
			{
				"text": "♪ You know the rules\nand so do I ♪",
				"start": 10,
				"duration": 5,
				"timestamp": "00:10"
			}
		],
		"wordCount": 458,
		"segments": 61
	}
}

YouTube Video Stats

GET https://api.socialkit.dev/youtube/stats?access_key=<your-access-key>&url=https://youtube.com/watch?v=dQw4w9WgXcQ

Response

{
	"success": true,
	"data": {
		"url": "https://youtube.com/watch?v=dQw4w9WgXcQ",
		"title": "Rick Astley - Never Gonna Give You Up (Official Video)",
		"channelName": "Rick Astley",
		"channelLink": "https://youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw",
		"views": 1428567890,
		"likes": 16234567,
		"comments": 4567890
	}
}

Introduction Authentication