Documentation

Comprehensive guides and technical documentation for developers and power users.

Getting Started

Core Features

Advanced Topics

SDKs & Libraries

Quick Start Guide

Get up and running with StudyBuddy in under 5 minutes.

1. Get Your API Key

Sign up for an account and get your API key from the dashboard.

API_KEY = "your-api-key-here"

2. Upload Your First File

Use our simple API to upload and process your study materials.

curl -X POST https://api.studybuddy.com/v1/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "type=pdf"

3. Get AI-Generated Content

Retrieve summaries and flashcards for your uploaded files.

curl -X GET https://api.studybuddy.com/v1/files/{file_id}/summary \
  -H "Authorization: Bearer YOUR_API_KEY"

API Reference

Complete API documentation with examples and response formats.

File Upload

POST /v1/files

Upload a file for AI processing and analysis.

Parameters

  • file (required): The file to upload (PDF, TXT)
  • type (required): File type (pdf, txt)
  • title (optional): Custom file title
  • tags (optional): Comma-separated tags

Response

{
  "id": "file_123",
  "title": "document.pdf",
  "status": "processing",
  "created_at": "2024-01-15T10:30:00Z"
}

Get Summary

GET /v1/files/{file_id}/summary

Retrieve AI-generated summary of the uploaded file.

Response

{
  "summary": "This document covers the fundamentals of...",
  "key_points": ["Point 1", "Point 2", "Point 3"],
  "confidence": 0.95,
  "generated_at": "2024-01-15T10:35:00Z"
}

Code Examples

Ready-to-use code examples in multiple programming languages.

JavaScript

const StudyBuddy = require('studybuddy-sdk');

const client = new StudyBuddy('your-api-key');

// Upload a file
const file = await client.uploadFile('document.pdf', 'pdf');

// Get summary
const summary = await client.getSummary(file.id);
console.log(summary.summary);

Python

from studybuddy import StudyBuddy

client = StudyBuddy('your-api-key')

# Upload a file
file = client.upload_file('document.pdf', 'pdf')

# Get summary
summary = client.get_summary(file.id)
print(summary.summary)

PHP

<?php
require_once 'vendor/autoload.php';

use StudyBuddy\StudyBuddy;

$client = new StudyBuddy('your-api-key');

// Upload a file
$file = $client->uploadFile('document.pdf', 'pdf');

// Get summary
$summary = $client->getSummary($file->id);
echo $summary->summary;

Need Help?

Can't find what you're looking for? Our developer support team is here to help.

Contact Developer Support View on GitHub