Examplary
    • Start for free
    Developer docs
    REST API

    Detect student name from scan

    POSThttps://api.examplary.ai/exams/{id}/sessions/scan-student-name

    Start a background task to detect the student name from a scanned page image.

    Path parameters

    idstringrequired

    Request body

    imagestring· urirequired

    Responses

    400 — Validation Error

    successbooleanrequired

    Allowed values:false

    errorarray any[]required
    dataanyrequired

    429 — Rate limit exceeded

    Requirements

    Rate limit

    60 requests per minute per user.

    User roles

    This endpoint requires the teacher, admin, or owner role to be present.

    OAuth scopes

    This endpoint requires the exams:write scope to be present.