Transkrip Akademik (Academic Transcript)

Transkrip Akademik (Academic Transcript).

This endpoint is currently in beta. It is not yet available in our production URL. Please contact us if you want to use this endpoint. Contact us via hi[at]glair.ai or via our representative for your company.

Transcript Object

Name
status
Type
string
Description
Enum code indicating the status of the reading result.
1. SUCCESS
2. NO_FILE
3. FILE_INVALID_FORMAT
4. FAILED
Name
reason
Type
string
Description
A human-readable message providing more details about the reading result.
Name
read
Type
object
Description
Contains the reading for each Transcript fields. Each fields has value (the reading).
- Name
  student_name
  Type
  string
  Description
  The name field refers to the full name of the individual to whom the academic transcript belongs. It should include both the first name and last name of the student.
- Name
  institution
  Type
  string
  Description
  The institution field refers to the educational institution from which the academic transcript is issued. This could be a university, college, or any other type of educational institution that offers accredited programs.
- Name
  faculty
  Type
  string
  Description
  The faculty field refers to the specific department or division within the institution to which the student belongs. For example, Faculty of Science, Faculty of Arts, etc.
- Name
  major
  Type
  string
  Description
  The major field refers to the specific area of study or specialization that the student pursued within the chosen faculty. This could be a specific subject or course of study, such as Computer Science, Biology, History, etc.
- Name
  gpa
  Type
  string
  Description
  The GPA (Grade Point Average) field refers to the student's overall academic performance represented as a numerical value. It provides an indication of the student's average performance across all courses and semesters. Include the GPA value in the response.
- Name
  education_level
  Type
  string
  Description
  The degree level field refers to the level of education that the individual has completed or is currently pursuing. This could include primary, secondary, or tertiary education, as well as vocational education. The educational level could also refer to the specific degree, such as a Bachelor's degree.

POST/ocr/v1/transcript

Read Transcript

Detects a valid Transcript image and returns the information as text.

Required parameter

Name
image
Type
file (.png, .jpg, .jpeg, .pdf)
Description
The image file for the Transcript.

Sample Request

POST

/ocr/v1/transcript


    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

    // Minimum Node 18. Save the code as 'index.mjs' and run it by executing 'node index.mjs'
import {readFileSync} from "fs";

const url = 'https://api.vision.glair.ai/ocr/v1/transcript';
const basicAuth = 'Basic ' + Buffer.from('USERNAME' + ':' + 'PASSWORD').toString('base64');
const apiKey = 'API_KEY';

const formData = new FormData();
formData.append('image', new Blob([readFileSync('/path/to/image/Transcript.jpeg')]));

const config = {
  method: 'POST',
  headers: {
  Authorization: basicAuth,
    'x-api-key': apiKey,
  },
  body: formData,
};

const response = await fetch(url, config);
console.log(await response.json());

Sample Response


    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

    {
    "status": "SUCCESS",
    "reason": "File Successfully Read",
    "read": {
        "student_name": {
            "value": "John Doe"
        },
        "institution": {
            "value": "Monster University"
        },
        "faculty": {
            "value": "Engineering"
        },
        "major": {
            "value": "Computer Science"
        },
        "gpa": {
            "value": "3.99"
        },
        "education_level": {
            "value": "Bachelor"
        }
    }
}

Request ID

An associated request identifier is generated for every request made to this endpoint. This value can be found in the response headers under Request-Id

Responses

Various responses for this endpoint, in addition to general responses specified in Errors.

`200 - OK`

Request with readable Transcript image

Response


    1
2
3
4
5

    {
    "status": "SUCCESS",
    "reason": "File Successfully Read",
    //...,
}

// TODO: no "Request with non Transcript File"?

`400 - Bad Request`

Request without form-data image

Response


    1
2
3
4
5

    {
    "status": "NO_FILE",
    "reason": "No file in request body",
    //...,
}

`415 - Unsupported Media Type`

Request with non-image file format

Response


    1
2
3
4
5

    {
    "status": "FILE_INVALID_FORMAT",
    "reason": "Failed to process invalid file format. Please upload the correct file format",
    //...,
}