Get started

Overview Quickstart Authentication Scopes API keys

Guides

Keeping data in sync The five registers Training evidence When a company's contract ends Sandbox company Example app

Reference

API reference Training records at a moment Every training record owed during a period Certificates at a moment Employees and invitations during a period Course versions referenced by employee records Policy versions Who owes which policy version Policy receipts A receipt's signed copy Check whether anything changed Field dictionary

Build

Build courses Course quickstart

What makes a great course Check a course

Files Blocks Questions Placeholders Limits

Checks file_not_allowed unsafe_path file_type not_utf8 json_invalid schema_invalid unknown_key file_missing over_limit family_not_available sdk_too_new player_line_unknown id_duplicate reference_unknown role_default_missing word_missing word_owner word_unused markup_not_allowed link_not_https link_host_undeclared placeholder_unknown placeholder_undeclared placeholder_in_link first_name_twin_missing contact_missing_word claim_word closing_names_ending answer_key_invalid explanation_missing feedback_missing held_question_on_page held_kind_not_allowed pool_too_small pool_small question_unused media_file_missing media_sha256_mismatch media_not_listed alt_missing captions_missing media_too_large context_not_allowed starter_words_left starter_media_left support_missing support_target_unknown source_not_linked quote_not_found fact_not_in_source lesson_long sentence_long few_situations film_sdk narration_placeholder pause_question_kind pause_question_elsewhere drawing_target_unknown drawing_target_missing lesson_without_question scenario_opening_missing refresher_question_first refresher_too_long certificate_pool_small certificate_pass_mark_missing walkthrough_steps_missing walkthrough_picture_missing change_before_missing change_question_missing video_opening_missing

Help

Rate limits Versioning Changelog Security Support AI tools

Format referenceChecks

`link_host_undeclared`

These words link to …, which kapi-works.json doesn't list in links. Add the host if people may open it.

Severity: Error. It blocks approval until it is fixed.
Course types: every type.
Who fixes it: you, with a choice that is yours to make.

How to fix it

Decide, then change the course to match. The finding's fixes says what to decide and holds the change that follows.

Blocks explains this part of the format.

Every check, with what each one says.

link_not_https

The link to … must start with https://.

placeholder_unknown

… isn't a placeholder Kapi fills. Use {company.name}, {contacts.<key>.name}, .email, .phone, .url or {learner.firstName}.

On this page