How do we get access?

Write to us through Contact Us or at info@cosqool.com and describe your platform. We issue a sandbox key first.

Is there a test environment?

Yes. The API Sandbox has its own key, its own data and an interactive reference. Nothing done there affects real students.

Commercial terms are agreed with each partner. There is no public price list for the API.

Do you send events to our server?

Yes, after your receiver address and credentials are registered. Until then the API itself always returns current data.

COSQOOL Partner API

For learning platforms that want to offer COSQOOL's Saudi-curriculum video courses to their own students, inside their own product.

Example

POST https://www.cosqool.com/api-sandbox/api/partner/v1/enrollments/
Authorization: Api-Key <your sandbox key>

{ "course_id": 17,
  "transaction_id": "order-1001",
  "external_student_id": "student-42",
  "duration": "monthly" }

201 Created
{ "id": 1, "status": "active", "expires_at": "2026-11-01T09:00:00Z" }

A sandbox request, shortened. The identifiers are placeholders.

What it covers

Catalogue: search courses by grade and semester, and read each course with its sections, lessons and items.
Enrolment: enrol one of your students in a course for a monthly, six-month or yearly term, and cancel it when needed.
Delivery: request the video address of a lesson for an enrolled student and play it in your own player.
Progress: record what a student completed and read the course progress back.
Notifications: once your receiver is registered, COSQOOL notifies your server about course updates, progress, completion and cancellation.

Who it is for

Education platforms, learning management systems and school networks that already have their own students and sign-in.

What you need

An API key issued by COSQOOL. Every partner starts in the sandbox, a separate test environment with its own key. A production key is issued at go-live, and commercial terms are agreed with each partner.

How it works

Contact us and tell us about your platform.
Receive a sandbox key and connect to the API Sandbox, which holds the full reference.
Build against the sandbox: search, enrol test students, play lessons and record progress.
Agree the go-live with us and receive your production key.

Good to know

Lessons are video lessons taught in Arabic for the Saudi curriculum: Grades 1 to 12, Semester 1 and Semester 2, plus Qudrat and Tahsili preparation.
You identify each student with your own identifier. COSQOOL never asks for your students' passwords.
A key works in one environment only and has a request rate limit. A sandbox key is refused on production.
Delivery covers each course's own lessons and files. The AI study tools of the COSQOOL dashboard are not part of it.
When a term ends or an enrolment is cancelled, new video requests for that student are refused.

Questions

How do we get access?: Write to us through Contact Us or at info@cosqool.com and describe your platform. We issue a sandbox key first.
Is there a test environment?: Yes. The API Sandbox has its own key, its own data and an interactive reference. Nothing done there affects real students.
What does it cost?: Commercial terms are agreed with each partner. There is no public price list for the API.
In which language is the reference?: In English.
Do you send events to our server?: Yes, after your receiver address and credentials are registered. Until then the API itself always returns current data.