Developer Options

API Reference

We expose essential parts of our backend to enable programmatic integrations. Currently, access is strictly limited to early access partners inside the University beta program.

Beta Notice

The v1 API parameters and rate limits are subject to change. Production applications should depend on official release announcements before scaling.

Authentication

Pass a Firebase valid Bearer token as your authorization header when sending a request.

bash

curl -H "Authorization: Bearer <FIREBASE_ID_TOKEN>" \
  https://api.studyshare.com/v1/materials

Available Endpoints

GET/v1/materials

Retrieves a paginated list of all accessible materials for the current user session.

json

{
  "success": true,
  "data": [
    {
      "id": "mat_123",
      "title": "Quantum Physics Notes",
      "type": "application/pdf"
    }
  ],
  "meta": {
    "total": 14,
    "page": 1
  }
}

POST/v1/chat

Initiates a conversation turn with the AI assistant. Provide optional context scopes.

json

{
  "message": "What did Professor Smith say about gravity?",
  "documents": ["mat_123", "mat_456"]
}

AI Assistant