Developer API Reference

Authorization: Bearer <your-supabase-access-token>

1. Sign in at scholaccess.com/login.
2. Open browser DevTools → Application tab → Local Storage → https://scholaccess.com.
3. Find the key whose value is a JSON object containing access_token. That JWT is your Bearer token.
4. Send it as Authorization: Bearer <token> on every request.

Tokens expire (typically 1 hour). Refresh by re-visiting the site or using the Supabase SDK to call refreshSession(). Requests without a valid token return HTTP 401.

Upload one or more files for accessibility remediation. Accepts PPTX, DOCX, PDF, XLSX, and common image formats (JPG, PNG, GIF, WebP, BMP, TIFF, HEIC). Each accepted file is queued and assigned a job ID. Files that are unsupported, too large (>25 MB), or exceed page/slide limits for your plan are reported in skipped but do not fail the request.

Content-Type: multipart/form-data

curl -X POST https://scholaccess.com/api/upload \
  -H "Authorization: Bearer $TOKEN" \
  -F "files=@slides.pptx" \
  -F "files=@handout.pdf"

# Response
{
  "job_ids": ["a1b2c3d4-...", "e5f6a7b8-..."],
  "skipped": []
}

Begin a chunked upload for a single large file (typically >25 MB). Returns an upload_id and the server's preferred chunk size. Follow this with repeated POST /api/upload/{upload_id}/chunk calls, then finalize with POST /api/upload/{upload_id}/complete.

Content-Type: application/json

curl -X POST https://scholaccess.com/api/upload/init \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"filename": "book.pdf", "total_size": 104857600}'

Upload a single chunk of a chunked upload. Chunks must be sent sequentially starting at index 0. Returns the index of the next expected chunk.

Content-Type: multipart/form-data

Finalize a chunked upload. The server reassembles the chunks, validates the file, and enqueues the remediation job. Returns a job_id that you can poll with GET /api/jobs/{job_id}.

curl -X POST https://scholaccess.com/api/upload/abc123/complete \
  -H "Authorization: Bearer $TOKEN"

Poll the status and metadata for a single remediation job. Returns 404 if the job does not exist or belongs to a different account.

curl https://scholaccess.com/api/jobs/a1b2c3d4-... \
  -H "Authorization: Bearer $TOKEN"

# Response (completed)
{
  "id": "a1b2c3d4-...",
  "status": "COMPLETED",
  "filename": "slides.pptx",
  "percent_done": 100,
  "has_output": true,
  "post_check": { ... },
  "created_at": "2026-04-23T14:00:00Z"
}

Download the remediated output file for a completed job. In production this returns a 302 redirect to a signed GCS download URL — use curl -L or follow redirects in your HTTP client. Returns 400 if the job is not yet completed.

# Download and save with the server-provided filename
curl -L -O -J https://scholaccess.com/api/jobs/a1b2c3d4-.../download \
  -H "Authorization: Bearer $TOKEN"

Return the authenticated user's account information, including current plan tier and monthly usage / quota counts. Useful for client-side quota displays and for checking remaining capacity before a large upload.

curl https://scholaccess.com/api/account \
  -H "Authorization: Bearer $TOKEN"

The documented API endpoints are described by a machine-readable OpenAPI 3.x spec auto-generated by FastAPI. The spec contains only the endpoints documented on this page. All endpoints require the Authorization: Bearer header described in section 1.