API Overview

Welcome to the Baizor International Chinese Smart Teaching Platform APIs! This document describes the API for the CSCA (International Chinese Smart Teaching Platform) to help developers integrate and use the platform.

Basic information

  • Base URL: https://api.baizor.com/v1
  • Authentication: Bearer Token
  • Content-Type: application/json

Authentication

All API requests must include the token in the header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Response format

All responses are JSON:

{
  "code": 200,
  "message": "success",
  "data": { ... }
}

Status codes

CodeDescription
200Success
400Bad request
401Unauthorized, invalid or expired token
403Forbidden
404Not found
500Server error

API usage and eligibility

Eligibility

Baizor International Chinese Smart Teaching Platform APIs are for educational institutions and developers. They allow you to integrate CSCA capabilities such as smart question generation and automated assessment into your teaching system or application.

API access is for educational use only (schools, language training institutions, online education platforms). The following are not allowed:

  • Illegal or harmful content
  • Bulk scraping or non-educational data mining
  • Reselling or proxying API access
  • Other violations of the Terms of Service

For enterprise needs (higher quotas, SLA, on-premise deployment), contact our business team.

Billing

Quotas

TierMonthly quotaFor
Free1,000 callsIndividual trial
Education50,000 callsCertified institutions
Professional200,000 callsPaid subscribers
EnterpriseCustomContracted partners
  • Quotas reset on the 1st of each month (UTC+8). Unused quota does not roll over.
  • Overage: Question API ¥0.05/call; Assessment API ¥0.08/call.

Use cases

  • LMS integration: Embed smart questions and assessment in school systems
  • Mobile apps: Chinese learning apps using platform APIs
  • Online courses: Exercises and assessment for courses
  • Research: Academic and teaching-effectiveness research (non-commercial)

Supported: Direct HTTP API, Python SDK (tongxin-csca), JavaScript/Node.js SDK (@tongxin/csca-sdk), Java SDK (Maven).

SLA

TierAvailabilityPlans
Standard99.5%Free, Education
Advanced99.9%Professional
Enterprise99.95%Enterprise

Support

  • Documentation and sample code
  • Developer community
  • Priority support for Professional and above
  • Dedicated success manager for Enterprise

For plan changes or details, see the Terms of Service or contact support@tongxinhanyu.com.

CSCA APIs

CSCA (Chinese Smart Classroom API) provides core interfaces for Chinese teaching: smart question generation and automated assessment. Endpoints, parameters, and response formats follow the same specification as the Chinese documentation. Use the Base URL and authentication above for all requests.

For full endpoint reference (question generation, assessment, etc.), see the Chinese API documentation or contact support for an English technical specification.