CF
Start

Academy SDK

CheFu Academy Docs

Build with CheFu Academy using official SDK clients, secured API keys, and language-native examples.

What is CheFu Academy?

CheFu Academy is CheFu Inc's learning platform for guided courses, learning videos, quizzes, flashcards, Q&A practice, progress tracking, and AI-assisted course generation.

The SDK gives developers a stable way to integrate that learning content into internal tools, apps, bots, dashboards, and custom education experiences.

Choose your SDK

Select the language you want to use. The same choice carries through the docs so install commands, authentication, requests, errors, and retries all match your stack.

Language example

Install the official client

Every official client talks to the same CheFu Academy API.

JavaScript / TypeScript

chefu-academy-sdk - npm

Use npm for Node.js, Next.js, backend services, and TypeScript projects.

Terminal
npm install chefu-academy-sdk
Language example

Create a client

Load CHEFU_API_KEY from your server environment or secret manager.

JavaScript / TypeScript

chefu-academy-sdk - npm

Initialize once in server-side code and reuse the SDK instance.

server.ts
import CheFuAcademy from 'chefu-academy-sdk';

const sdk = new CheFuAcademy({
  apiKey: process.env.CHEFU_API_KEY,
  timeout: 10000,
});
Language example

Make the first content request

Use language-native method names while keeping the same API concepts.

JavaScript / TypeScript

chefu-academy-sdk - npm

courses.ts
const courses = await sdk.courses.search({
  query: 'machine learning',
  category: 'Technology',
  limit: 10,
});

const course = await sdk.courses.getById(courses.courses[0].id);
const lessons = await sdk.courses.getLessons(course.id, 0);
const quiz = await sdk.courses.getQuiz(course.id);

What you can build

Course discovery pages powered by CheFu Academy content.
Learning dashboards that pull chapters, lessons, and practice material.
Video libraries that include uploaded videos and YouTube-backed lessons.
Backend services that safely query CheFu Inc APIs with developer keys.

SDK surface

Courses

Browse, search, feature, and read course chapters, lessons, quizzes, flashcards, and Q&A.

Videos

Fetch uploaded and YouTube-backed videos, search them, or filter by category.

API keys

Create, list, and revoke developer API keys from authenticated SDK sessions.

cURL helper

Call Academy endpoints from shell scripts, CI jobs, or quick terminal checks.

Security model

Developer keys are created only by authenticated users with the developer role. The backend validates keys, checks the public identifier, hashes the secret portion, and rejects revoked or compromised keys.

Keep API keys on the server

API keys use the format chf_publicId_secret. Do not place them in client-side bundles, public repositories, screenshots, or logs.

Next steps