API reference

Public catalog reads require no key. Use a verified session or scoped Bearer key for private collections. Framework generation endpoints are disabled in this video library. Never expose keys. See OpenAPI.

How do I use listJobs?

Disabled framework operation. Disabled in the Math Video aggregator profile. Use the catalog endpoints to browse videos and manage collections.

GET /api/v1/jobs — 200 Successful response; 401 Invalid or expired key; 403 Permission missing; 429 Rate limit exceeded; 503 Generation is disabled in this product..

How do I use createJob?

Disabled framework operation. Disabled in the Math Video aggregator profile. Use the catalog endpoints to browse videos and manage collections.

POST /api/v1/jobs — 200 Successful response; 202 Task queued; 401 Invalid or expired key; 402 Insufficient credits; 403 Permission missing; 409 Operation key conflicts with different input; 429 Rate limit exceeded; 503 Generation is disabled in this product..

How do I use getJob?

Disabled framework operation. Disabled in the Math Video aggregator profile. Use the catalog endpoints to browse videos and manage collections.

GET /api/v1/jobs/{id} — 200 Successful response; 401 Invalid or expired key; 403 Permission missing; 429 Rate limit exceeded; 503 Generation is disabled in this product..

How do I use downloadResult?

Disabled framework operation. Disabled in the Math Video aggregator profile. Use the catalog endpoints to browse videos and manage collections.

GET /api/v1/jobs/{id}/result — 200 Successful response; 401 Invalid or expired key; 403 Permission missing; 429 Rate limit exceeded; 503 Generation is disabled in this product..

How do I use getQuota?

GET /api/v1/quota — 200 Successful response; 401 Invalid or expired key; 403 Permission missing; 429 Rate limit exceeded.

How do I use catalogVideos?

GET /api/catalog/videos — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use catalogFacets?

GET /api/catalog/facets — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use catalogVideo?

GET /api/catalog/videos/{slug} — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use submitVideo?

POST /api/catalog/submissions — 201 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use listCollections?

GET /api/catalog/collections — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use createCollection?

POST /api/catalog/collections — 201 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use getCollection?

GET /api/catalog/collections/{id} — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use patchCollection?

PATCH /api/catalog/collections/{id} — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use deleteCollection?

DELETE /api/catalog/collections/{id} — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use putBookmark?

PUT /api/catalog/collections/{id}/videos/{videoId} — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

How do I use deleteBookmark?

DELETE /api/catalog/collections/{id}/videos/{videoId} — 200 Success; 400 Invalid input; 401 Authentication required; 403 Wrong scope, owner, origin or administrator permission; 404 Not found.

Use catalog:read and catalog:write scopes for collection access. Administrator review requires a fresh verified browser session and two-factor authentication; API keys cannot perform administrator actions. AI analysis and paid search are disabled at launch.

Material language and scripts

GET /api/catalog/videos/{slug}?locale=en selects English materials; locale=zh selects Chinese. material.payload.script contains timestamped original educational explanations. transcript is a separate actual-speech field and may be empty. The two should not be conflated.