AI

Get a lesson note

Returns one lesson note with its sections.

GEThttps://api.klasstack.com/v1/ai/lesson-notes/{id}

  • ai:read
  • Billable
  • Test key: example response

Authorizations

  • Authorizationstringheaderrequired

    Your secret key as a bearer token, in the form Bearer ks_live_sk_... or Bearer ks_test_sk_.... Keep it on your server. A test key gets the documented example and touches no school data.

Path Parameters

  • idstringpathrequired

    Example: 33

Response

200, application/json

  • dataobjectrequired

    Show child attributes
    • idnumberrequired

    • titlestringrequired

    • statusstringrequired

    • courseIdnumberrequired

    • classLevelIdnumber or nullrequired

    • classSectionIdnumber or nullrequired

    • academicPeriodIdnumberrequired

    • sectionsobject[]required

      Show child attributes of each item
      • keystringrequired

      • labelstringrequired

      • htmlstringrequired

        Sanitized HTML.

    • createdAtstring or nullrequired

  • metaobjectrequired

    Show child attributes
    • request_idstringrequired

      Also returned in the X-Request-ID header.

    • paginationobject

      Show child attributes
      • limitintegerrequired

        Required range: x <= 100

      • has_morebooleanrequired

      • next_cursorstring or nullrequired

        Send this back as cursor for the next page. Opaque: never parse it.

Errors

What each code means, and what to do about it, is in the errors guide.

Webhook events

This call triggers no webhook event.