API

clients

clients.
python

Get Python client.
output filesone

clients.
typescript

Get TypeScript client.
output filesone

clients.
javascript

Get JavaScript client.
output filesone

clients.
java

Get Java client.
output filesone

clients.
cpp

Get Cpp client.
output filesone

clients.
php

Get PHP client.
output filesone

auth

auth.
login

Login: Get an access token.

Returns a token on success. Throws UnauthorizedError on failure.

input
CredentialsIn
output
CredentialsOut

auth.
logout

Logout: Discard the access token.

auth.
loginExam

Login to an exam: Get an access token for an exam.

Returns a token on success. Throws UnauthorizedError on failure.

input
ExamCredentialsIn
output
CredentialsOut

auth.
getReadyExams

Get list of ready exams for a user, given their credentials.

Validates user credentials and returns the list of ready exams. Does not create a session or return a token.

input
CredentialsIn
output
array of
ReadyExam

auth.
loginWithUsername

Login: Get an access token.

Returns a token on success. Throws UnauthorizedError on failure. Created for backward compatibility, do not use.

input
CredentialsWithUsernameIn
output
CredentialsOut

auth.
register

Register a new user account.

Creates a new user with the provided profile data. Requires a valid reCAPTCHA v3 token.

input
RegisterIn

auth.
requestPasswordReset

Request a password reset link by email.

Sends a reset link to the user if the email is registered. Always succeeds silently for unknown emails. Requires a valid reCAPTCHA v3 token.

input
RequestPasswordResetIn

auth.
confirmPasswordRequest

Confirm a password reset and set a new password.

Validates the reset code and sets a new password. Requires a valid reCAPTCHA v3 token.

input
ConfirmPasswordRequestIn

auth.
requestUnregistration

Request account unregistration confirmation link by email.

Verifies the current password and sends an unregistration confirmation link. Requires authentication and a valid reCAPTCHA v3 token.

input
RequestUnregistrationIn

auth.
confirmUnregistration

Confirm account unregistration.

Validates the unregistration code, removes the account, unlinks course enrollments, and invalidates all sessions. Requires authentication and a valid reCAPTCHA v3 token. Warning: This action is irreversible!!!

input
ConfirmUnregistrationIn

auth.
requestChangeEmail

Request an email address change confirmation link.

Verifies the current password and sends a confirmation link to the new email address. Requires authentication and a valid reCAPTCHA v3 token.

input
RequestChangeEmailIn

auth.
confirmChangeEmail

Confirm an email address change.

Validates the email change code, updates the account email, migrates course enrollments, and invalidates all sessions. Requires authentication and a valid reCAPTCHA v3 token.

input
ConfirmUnregistrationIn

misc

misc.
getApiVersion

Get version information of the API.
output
ApiVersion

misc.
getRequestInformation

Get requestion information.
output
RequestInformation

misc.
getFortune

Get a fortune message.
output
string

misc.
getTime

Get server time.
output
Time

misc.
getHomepageStats

Get homepage stats.
output
HomepageStats

misc.
getLogo

Get Jutge.org logo as a PNG file.
output filesone

misc.
getAvatarPacks

Returns all packs of avatars.

Avatars are used in exams and contests to identify students or participants.

output
array of
string

misc.
getExamIcons

Returns all exam icons.

Exam icon are used in exams and contests to identify problems.

output
TagsDict

misc.
getColors

Returns color mappings using colornames notation.

Color mappings may be used to colorize keys in the frontends. Color names are as defined in https://github.com/timoxley/colornames

output
ColorMapping

misc.
getHexColors

Returns color mappings using hexadecimal color notation.

Color mappings may be used to colorize keys in the frontends.

output
ColorMapping

misc.
getDemosForCompiler

Returns code demos for a given compiler as a dictionary of base64 codes indexed by problem_nm.
input
string
output
dict of
string

tables

tables.
get

Returns all tables.

Returns all compilers, countries, drivers, languages, proglangs, and verdicts in a single request. This data does not change often, so you should only request it once per session.

output
AllTables

tables.
getLanguages

Returns all languages.

Returns all languages as a dictionary of objects, indexed by id.

output
dict of
Language

tables.
getCountries

Returns all countries.

Returns all countries as a dictionary of objects, indexed by id.

output
dict of
Country

tables.
getCompilers

Returns all compilers.

Returns all compilers as a dictionary of objects, indexed by id.

output
dict of
Compiler

tables.
getDrivers

Returns all drivers.

Returns all drivers as a dictionary of objects, indexed by id.

output
dict of
Driver

tables.
getVerdicts

Returns all verdicts.

Returns all verdicts as a dictionary of objects, indexed by id.

output
dict of
Verdict

tables.
getProglangs

Returns all proglangs.

Returns all proglangs (porgramming languages) as a dictionary of objects, indexed by id.

output
dict of
Proglang

tables.
getTimezones

Returns all timezones.

Returns all timezones as a dictionary of objects, indexed by id.

output
dict of
Timezone

courses

courses.
indexPublic

Get all public courses.

Returns all courses marked as public, indexed by course key (`username:course_nm`).

output
PublicCourses

problems

problems.
getAllAbstractProblems

Get all available abstract problems.

Includes problems.

output
dict of
AbstractProblem

problems.
getAllAbstractProblemsRaw

Test of getting abstract problems

Bla bla

output
dict of
AbstractProblem

problems.
getAbstractProblems

Get available abstract problems whose keys are in `problem_nms`.

Includes problems.

input
string
output
dict of
AbstractProblem

problems.
getAbstractProblemsInList

Get available abstract problems that belong to a list.

Includes problems.

input
string
output
dict of
AbstractProblem

problems.
getAbstractProblem

Get an abstract problem.

Includes problems

input
string
output
AbstractProblem

problems.
getAbstractProblemSuppl

Get supplementary information of an abstract problem.

Includes accepted compilers and accepted proglangs

input
string
output
AbstractProblemSuppl

problems.
getManyAbstractProblemSuppl

Get supplementary information of many abstract problems.

Includes accepted compilers and accepted proglangs. Keys are `problem_nm`s.

input
string
output
AbstractProblemSuppls

problems.
getProblem

Get a problem.

Includes abstract problem.

input
string
output
Problem

problems.
getProblemSuppl

Get supplementary information of a problem.

Includes accepted compilers, accepted proglangs, official solutions checks and handler specifications

input
string
output
ProblemSuppl

problems.
getSampleTestcases

Get sample testcases of a problem.
input
string
output
array of
Testcase

problems.
getPublicTestcases

Get public testcases of a problem.

Public testcases are like sample testcases, but are not meant to be shown in the problem statatement, because of their long length.

input
string
output
array of
Testcase

problems.
getZipStatement

Get ZIP archive of a problem. This includes its statements, templates and public testcases.
input
string
output filesone

problems.
getPdfStatement

Get PDF statement of a problem.
input
string
output filesone

problems.
getHtmlStatement

Get Html statement of a problem.
input
string
output
string

problems.
getTextStatement

Get Text statement of a problem.
input
string
output
string

problems.
getMarkdownStatement

Get Markdown statement of a problem.
input
string
output
string

problems.
getShortHtmlStatement

Get short Html statement of a problem (does not include title or author).
input
string
output
string

problems.
getShortTextStatement

Get short Text statement of a problem (does not include title or author).
input
string
output
string

problems.
getShortMarkdownStatement

Get short Markdown statement of a problem (does not include title or author).
input
string
output
string

problems.
getTemplates

Get list of template files of a problem (`main.*`, `code.*`, `public.tar`, etc.).
input
string
output
array of
string

problems.
getTemplate

Get a template file of a problem.
input
problem_id
string
template
string
output filesone

problems.
semanticSearch

Get results for a semantic search for statement problems. The array is sorted by score (better at the top).
input
query
string
limit
number
output
SearchResults

problems.
fullTextSearch

Get results for a full text search for statement problems. The array is sorted by score (better at the top). Queries are matched against titles and statements and can use boolean operators.
input
query
string
limit
number
output
SearchResults

student.keys

student.keys.
get

Get problem, courses (as enrolled and available) and list keys.
output
AllKeys

student.keys.
getProblems

Get problem keys.
output
array of
string

student.keys.
getEnrolledCourses

Get enrolled course keys.
output
array of
string

student.keys.
getAvailableCourses

Get available course keys.
output
array of
string

student.keys.
getLists

Get list keys.
output
array of
string

student.profile

student.profile.
get

Get the profile.

In case of exams, some fields are not nullified to avoid cheating.

output
Profile

student.profile.
getAvatar

Returns the avatar as a PNG file.
output filesone

student.profile.
update

Update the profile
input
NewProfile

student.profile.
updateAvatar

Update the avatar with new PNG.
input filesone

student.profile.
updatePassword

Update password.

Receives the old password and the new one, and changes the password if the old one is correct and the new one strong enough.

input
NewPassword

student.dashboard

student.dashboard.
getAbsoluteRanking

Get the ranking of the user over all users in the system.
output
integer

student.dashboard.
getAllDistributions

Get all distributions.
output
AllDistributions

student.dashboard.
getCompilersDistribution

Get compilers distribution.
output
Distribution

student.dashboard.
getDashboard

Get dashboard.
output
Dashboard

student.dashboard.
getHeatmapCalendar

Get heatmap calendar of submissions.
output
HeatmapCalendar

student.dashboard.
getProglangsDistribution

Get programming languages distribution.
output
Distribution

student.dashboard.
getStats

Get dashboard stats.
output
Distribution

student.dashboard.
getLevel

Get fancy Jutge level.
output
string

student.dashboard.
getSubmissionsByHour

Get submissions by hour distribution.
output
Distribution

student.dashboard.
getSubmissionsByWeekDay

Get submissions by weekday distribution.
output
Distribution

student.dashboard.
getVerdictsDistribution

Get verdicts distribution.
output
Distribution

student.submissions

student.submissions.
indexForAbstractProblem

Get index of all submissions for an abstract problem.

Grouped by problem.

input
string
output
dict of
dict of
Submission

student.submissions.
indexForProblem

Get index of all submissions for a problem.
input
string
output
dict of
Submission

student.submissions.
getForAbstractProblems

Get all submissions for a list of abstract problems.

Flat array of submissions from newer to older.

input
string
output
array of
Submission

student.submissions.
getAll

Get all submissions.

Flat array of submissions from newer to older.

output
array of
Submission

student.submissions.
getRange

Get list of submissions in a range of dates.

Flat array of submissions from newer to older for a given range of dates.

input
DateRange2
output
array of
Submission

student.submissions.
submit

Submit a solution to the Judge, easy interface.
input
problem_id
string
compiler_id
string
code
string
annotation
string
output
string

student.submissions.
submitFull

Submit a solution to the Judge, full interface.
input
NewSubmissionIn
input filesmany
output
NewSubmissionOut

student.submissions.
get

Get a submission.
input
GetGameResultIn
output
Submission

student.submissions.
getCodeAsB64

Get code for a submission as a string in base64.
input
GetGameResultIn
output
string

student.submissions.
getCompilationErrors

Get compilation errors for a submission.
input
GetGameResultIn
output
CompilationErrors

student.submissions.
getCodeMetrics

Get code metrics for a submission.
input
GetGameResultIn
output
CodeMetrics
or
null

student.submissions.
getScoring

Get partial scoring for a submission.
input
GetGameResultIn
output
Scoring

student.submissions.
getAwards

Get list of awards ids for a submission.
input
GetGameResultIn
output
array of
string

student.submissions.
getAnalysis

Get analysis of a submission.
input
GetGameResultIn
output
array of
SubmissionAnalysis

student.submissions.
getTestcaseAnalysis

Get a (public) testcase analysis of a submission.
input
problem_id
string
submission_id
string
testcase
string
output
TestcaseAnalysis

student.submissions.
getCircuitModules

Get the modules of a circuit submission. Only for circuits. Each element is an SVG string.
input
GetGameResultIn
output
dict of
string

student.submissions.
getCircuitTracesJson

Get the error report traces of a circuit submission.
input
GetGameResultIn
output
Settings

student.submissions.
getCircuitTracesSvg

Get the error report traces of a circuit submission.
input
GetGameResultIn
output
dict of
string

student.submissions.
getGameResult

Get the result of a game submission.
input
GetGameResultIn
output
GetGameResultOut

student.submissions.
getGameOutput

Get the output of a game in a game submission.
input
GetGameOutputIn
output
string

student.submissions.
getDebugInformation

Get debug information for a submission.
input
GetGameResultIn
output
DebugInformation
or
null

student.courses

student.courses.
indexAvailable

Get index of all available courses.
output
dict of
BriefCourse

student.courses.
indexEnrolled

Get index of all enrolled courses.
output
dict of
BriefCourse

student.courses.
getAvailable

Get an available course.

Includes owner and lists.

input
string
output
Course

student.courses.
getEnrolled

Get an enrolled course.

Includes owner and lists.

input
string
output
Course

student.courses.
enroll

Enroll in an available course.
input
string

student.courses.
unenroll

Unenroll from an enrolled course.
input
string

student.courses.
getArchivedKeys

Get the keys of all archived courses.
output
array of
string

student.courses.
archive

Archive an enrolled course.
input
string

student.courses.
unArchive

Unarchive an archived course.
input
string

student.lists

student.lists.
getAll

Get all lists.
output
dict of
BriefList

student.lists.
get

Get a list.

Includes items, owner.

input
string
output
List

student.lists.
getMany

Get many lists.

Includes items, owner. Keys are `list_key`s.

input
string
output
dict of
List

student.exam

student.exam.
getReadyExams

Get list of ready exams.

An exam is ready if the current time is between its expected start time minus two days and its expected end time plus two days. Exams are sorted by their distance to the current time and by title order in case of ties.

output
array of
ReadyExam

student.exam.
get

Get current exam.
output
RunningExam

student.exam.
getDocument

Get a document in an exam.
input
string
output
RunningExamDocument

student.exam.
getDocumentPdf

Get PDF of a document in an exam.
input
string
output filesone

student.exam.
getRanking

Get ranking of the current contest.
output
Ranking

student.exams

student.exams.
getAll

Get all exams linked to the user.
output
BriefExams

student.exams.
get

Get an exam linked to the user.
input
string
output
Exam

student.statuses

student.statuses.
getAll

Get statuses for all abstract problems.
output
dict of
AbstractStatus

student.statuses.
getForAbstractProblem

Get status for an abstract problem.
input
string
output
AbstractStatus

student.statuses.
getForProblem

Get status for a problem.
input
string
output
Status

student.awards

student.awards.
getAll

Get all awards.
output
dict of
BriefAward

student.awards.
get

Get an award.
input
string
output
Award

student.settings

student.settings.
getAll

Get all user settings.
output
Settings

student.settings.
get

Get a user setting by key.
input
string
output

student.settings.
set

Set a user setting.
input
Setting

tutor.courses

tutor.courses.
getCoursesKeys

Get course keys the user can tutorize.

Returns courses where the user is enrolled as a tutor.

output
array of
string

tutor.courses.
getEnrolledStudents

Get students enrolled in a course.

Returns name and email for each student enrolled in the given course. Gated to courses the user can tutorize.

input
string
output
array of
EnrolledStudent

tutor.profile

tutor.profile.
get

Get the public profile of a student.

Returns the public profile for the given email. Gated to students enrolled in courses the user can tutorize.

input
string
output
PublicProfile

tutor.profile.
getAvatar

Returns the avatar of a student as a PNG file.

Returns the avatar for the given email. Gated to students enrolled in courses the user can tutorize.

input
string
output filesone

tutor.statuses

tutor.statuses.
getAll

Get statuses for all abstract problems in a course.
input
course_key
string
email
string
output
dict of
AbstractStatus

tutor.statuses.
getForAbstractProblem

Get status for an abstract problem in a course.
input
course_key
string
email
string
problem_nm
string
output
AbstractStatus

tutor.statuses.
getForProblem

Get status for a problem in a course.
input
course_key
string
email
string
problem_id
string
output
Status

tutor.submissions

tutor.submissions.
indexForAbstractProblem

Get index of all submissions for an abstract problem in a course.
input
course_key
string
email
string
problem_nm
string
output
dict of
dict of
TutorSubmission

tutor.submissions.
indexForProblem

Get index of all submissions for a problem in a course.
input
course_key
string
email
string
problem_id
string
output
dict of
TutorSubmission

tutor.submissions.
getForAbstractProblems

Get all submissions for a list of abstract problems in a course.
input
course_key
string
email
string
problem_nms
string
output
array of
TutorSubmission

tutor.submissions.
getAll

Get all submissions for a supervised student in a course.
input
course_key
string
email
string
output
array of
TutorSubmission

tutor.submissions.
get

Get a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
TutorSubmission

tutor.submissions.
getCodeAsB64

Get code for a submission as a string in base64.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
string

tutor.submissions.
getCompilationErrors

Get compilation errors for a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
CompilationErrors

tutor.submissions.
getCodeMetrics

Get code metrics for a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
CodeMetrics
or
null

tutor.submissions.
getScoring

Get partial scoring for a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
Scoring

tutor.submissions.
getAwards

Get list of awards ids for a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
array of
string

tutor.submissions.
getAnalysis

Get analysis of a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
output
array of
SubmissionAnalysis

tutor.submissions.
getTestcaseAnalysis

Get a (public) testcase analysis of a submission.
input
course_key
string
email
string
problem_id
string
submission_id
string
testcase
string
output
TestcaseAnalysis

instructor.documents

instructor.documents.
index

Get index of all documents.
output
dict of
Document

instructor.documents.
get

Get a document.

The file content is not included in the response.

input
string
output
Document

instructor.documents.
getPdf

Get PDF of a document.
input
string
output filesone

instructor.documents.
getZip

Get ZIP of a document.
input
string
output filesone

instructor.documents.
create

Create a new document.
input
DocumentCreation
input filesone

instructor.documents.
update

Update a document.
input
DocumentCreation
input filesone

instructor.documents.
remove

Remove a document.
input
string

instructor.lists

instructor.lists.
index

Get index of all lists.
output
dict of
InstructorBriefList

instructor.lists.
get

Get a list.
input
string
output
InstructorList

instructor.lists.
create

Create a new list.
input
InstructorListCreation

instructor.lists.
update

Update an existing list.
input
InstructorListCreation

instructor.lists.
remove

Delete an existing list.
input
string

instructor.lists.
getArchived

Get the list of lists that are archived.

At some point, endpoints related to archiving lists should change as the archive bit will be an attribute of each list.

output
array of
string

instructor.lists.
archive

Archive a list.
input
string

instructor.lists.
unarchive

Unarchive a list.
input
string

instructor.courses

instructor.courses.
index

Get index of all courses.
output
dict of
InstructorBriefCourse

instructor.courses.
get

Get a course.
input
string
output
InstructorCourse

instructor.courses.
create

Create a new course.

Only invited students and tutors are taken into account. Enrolled and pending students and tutors are ignored, as these are managed by the system.

input
InstructorCourseCreation

instructor.courses.
update

Update an existing course.

Only invited students and tutors are taken into account. Enrolled and pending students and tutors are ignored, as these are managed by the system.

input
InstructorCourseUpdate

instructor.courses.
updateIcon

Update the icon of a course.
input
InstructorCourseUpdateIconInput

instructor.courses.
remove

Delete an existing course.

A course should not be deleted. Ask a system administrator to remove it if you really need it.

input
string

instructor.courses.
sendInviteToStudents

Send invite email to pending students in the course.

Please do not abuse.

input
string

instructor.courses.
sendInviteToTutors

Send invite email to pending tutors in the course.

Please do not abuse.

input
string

instructor.courses.
getCourseSubmissions

Get all submissions for a course.

Returns all submissions for all problems in all lists of the course, from all enrolled students. Each submission includes the student user uid, email, time, problem id, verdict, compiler id, and programming language.

input
string
output
array of
CourseSubmission

instructor.courses.
getStudentProfiles

Get the profiles of the students enrolled in the course.
input
string
output
dict of
StudentProfile

instructor.courses.
getTutorProfiles

Get the profiles of the tutors enrolled in the course.
input
string
output
dict of
StudentProfile

instructor.courses.
getArchived

Get the list of courses that are archived.

At some point, endpoints related to archiving courses should change as the archive bit will be an attribute of each course.

output
array of
string

instructor.courses.
archive

Archive a course.
input
string

instructor.courses.
unarchive

Unarchive a course.
input
string

instructor.exams

instructor.exams.
index

Get index of all exams.
output
dict of
InstructorBriefExam

instructor.exams.
get

Get an exam.
input
string
output
InstructorExam

instructor.exams.
getDocuments

Get documents of an exam.
input
string
output
array of
RunningExamDocument

instructor.exams.
getProblems

Get problems of an exam.
input
string
output
array of
InstructorExamProblem

instructor.exams.
getStudents

Get students of an exam.
input
string
output
array of
InstructorExamStudent

instructor.exams.
getStudent

Get an student of an exam.
input
exam_nm
string
email
string
output
InstructorExamStudent

instructor.exams.
getSubmissions

Get submissions of an exam as a webstream.

Meant for real-time streaming of submissions, most instructors will possibly prefer getSubmissionsPack.

input
exam_nm
string
options
InstructorExamSubmissionsOptions
output
WebStream

instructor.exams.
getSubmissionsPack

Get submissions of an exam as a pack.

This endpoint will prepare the pack in the background and return a link to download it later. Packs take some time to be prepared, and are deleted after 24 hours. This is the preferred endpoint for most instructors, as it is simpler to use than getSubmissions.

input
exam_nm
string
options
InstructorExamSubmissionsOptions
output
Pack

instructor.exams.
getStatistics

Get statistics of an exam.
input
string
output
ExamStatistics

instructor.exams.
create

Create a new exam.
input
InstructorExamCreation

instructor.exams.
update

Update an existing exam.
input
InstructorExamUpdate

instructor.exams.
updateDocuments

Update documents of an exam.
input
exam_nm
string
document_nms
array of
string

instructor.exams.
updateCompilers

Update compilers of an exam.
input
exam_nm
string
compiler_ids
array of
string

instructor.exams.
updateProblems

Update problems of an exam.
input
exam_nm
string
problems
array of
InstructorExamProblem

instructor.exams.
updateStudents

Update students of an exam.
input
exam_nm
string
students
array of
InstructorExamStudent

instructor.exams.
addStudents

Add students to an exam.
input
exam_nm
string
students
array of
InstructorExamStudent

instructor.exams.
removeStudents

Remove students from an exam.
input
exam_nm
string
emails
array of
string

instructor.exams.
remove

Delete an existing exam.

Note: An exam can only be deleted if it has not started.

input
string

instructor.exams.
getArchived

Get the list of exams that are archived.

At some point, endpoints related to archiving exams should change as the archive bit will be an attribute of each exam.

output
array of
string

instructor.exams.
archive

Archive an exam.
input
string

instructor.exams.
unarchive

Unarchive an exam.
input
string

instructor.exams.
getRanking

Get the ranking.

Under development.

input
string
output
Ranking

instructor.problems

instructor.problems.
getOwnProblems

Get the list of own problems.
output
array of
string

instructor.problems.
setSharingSettings

Set the sharing settings of a problem.

Without a passcode, the problem is visible to all users. With a passcode, the problem is only visible to users with the correct passcode. With shared testcases, the testcases are shared with instructors. With shared solutions, the solutions are shared with instructors.

input
SharingSettings

instructor.problems.
getSharingSettings

Get the sharing settings of a problem.
input
string
output
SharingSettings

instructor.problems.
getAllSharingSettings

Get the sharing settings of all problems.
output
array of
SharingSettings

instructor.problems.
getAlerts

Get alerts for one problem.
input
string
output
ProblemAlerts

instructor.problems.
getAllAlerts

Get alerts for all problems.
output
array of
ProblemAlerts

instructor.problems.
shareWith

Share a problem with users.
input
ShareWithInp

instructor.problems.
setDeprecation

Set the deprecation of a problem.

If the reason is null or empty, the problem is undeprecated.

input
Deprecation

instructor.problems.
getProblemPopularityBuckets

Get the popularity buckets for all problems.

The buckets are sorted by the number of problems in each bucket by total number of submissions. The data is refreshed every hour.

output
array of
ProblemPopularityBucketEntry

instructor.problems.
getAnonymousSubmissions

Get anonymous submissions for an abstract problem.

This function is useful to produce statistics about the submissions for an abstract problem. The user ids are anonymized using a nonce.

input
string
output
array of
ProblemAnonymousSubmission

instructor.problems.
download

Download a problem as a ZIP file.
input
string
output filesone

instructor.problems.
getAllTestcases

Get all testcases of a problem.

Permission is granted to admins, the problem owner, or any instructor if testcases are shared.

input
string
output
array of
Testcase

instructor.problems.
getSolutions

Get list of proglangs for which the problem has an official solution.

Permission is granted to admins and instructors who own the problem.

input
string
output
array of
string

instructor.problems.
getSolutionAsB64

Get official solution for a problem in proglang as a string in base64.

Permission is granted to admins and instructors who own the problem.

input
problem_id
string
proglang
string
output
string

instructor.problems.
getSolutionAsFile

Get official solution for a problem in proglang as a file.

Permission is granted to admins and instructors who own the problem.

input
problem_id
string
proglang
string
output filesone

instructor.problems.
create

Create a problem from a ZIP archive.

This endpoint uses terminal web streaming: It returns an id from which the problem feedback is streamed over <URL>/api/webstreams/<id>.

input
string
input filesone
output
WebStream

instructor.problems.
update

Update a problem from a ZIP archive.

This endpoint uses terminal web streaming: It returns an id from which the problem feedback is streamed over <URL>/api/webstreams/<id>.

input
string
input filesone
output
WebStream

instructor.problems.
remove

Remove a problem.

A problem can only be removed if it has few submissions.

input
string

instructor.queries

instructor.queries.
getCourseProblemSubmissions

Get submissions for a problem in a course.

Returns a list of submissions for a given problem for all students of a given course. Each submission includes the email, time, problem name, problem id, verdict, and IP address. The list is ordered by email and time. Known as ricard01 in the past.

input
course_nm
string
problem_nm
string
output
SubmissionsQuery

instructor.queries.
getCourseListSubmissions

Get submissions for all problems in a list in a course.

Returns a list of submissions for all problems in a given list for all students of a given course. Each submission includes the email, time, problem name, problem id, verdict, and IP address. The list is ordered by email, problem id and time. Known as ricard02 in the past.

input
course_nm
string
list_nm
string
output
SubmissionsQuery

instructor.tags

instructor.tags.
index

Get list of all tags.
output
array of
string

instructor.tags.
getDict

Get all tags with their problems.
output
TagsDict

instructor.tags.
get

Get all problems with a given tag.
input
string
output
array of
string

instructor.jutgeai

instructor.jutgeai.
supportedModels

Get the list of supported models.
output
array of
string

instructor.jutgeai.
supportedImageModels

Get the list of supported image models.
output
array of
string

instructor.jutgeai.
chat

Chat with an AI model using a list of messages.

Send a conversation (list of system|user|assistant messages) and get the next assistant reply. Models are listed in the `supportedModels` endpoint. This endpoint uses terminal web streaming: It returns an id from which the chat is streamed over <URL>/api/webstreams/<id>. If `addUsage` is true, the usage of the model will be added at the end of the response as a JSON object between `---USAGE_JSON_START---` and `---USAGE_JSON_END---`.

input
ChatPrompt
output
WebStream

instructor.jutgeai.
createImage

Create an image using an AI image model.

Some models only accept certain sizes and aspect ratios.

input
CreateImageInput
output filesone

instructor.jutgeai.
getLlmUsage

Get audit usage of LLM models.
output
array of
LlmUsageEntry

games

games.
getGames

Get list of problems that are games.
output
array of
string

games.
getDummy

Get dummy player for a game.
input
string
output
string

games.
getViewer

Get a ZIP file with the viewer for a game.
input
string
output filesone

games.
submitMatch

Submit a match for a game (combat or competition match).
input
SubmitMatchIn
output
NewSubmissionOut

admin.instructors

admin.instructors.
get

Get instructors.
output
InstructorEntries

admin.instructors.
add

Add an instructor.
input
email
string
username
string

admin.instructors.
remove

Remove an instructor.
input
string

admin.courses

admin.courses.
getAll

Get all courses from all instructors.
output
AdminCourses

admin.courses.
setPublicAndOfficial

Set the public and official fields of a course.
input
AdminCourseSetPublicAndOfficial

admin.users

admin.users.
count

Count users
output
integer

admin.users.
create

Create a user
input
UserCreation

admin.users.
remove

Remove a user
input
string

admin.users.
setPassword

Set a password for a user
input
email
string
password
string
message
string

admin.users.
getProfiles

Get all profiles of users whose email or name contains a specific string
input
string
output
array of
ProfileForAdmin

admin.users.
getAllWithEmail

Get all users (well, just email and name) whose email contains a specific string
input
string
output
UsersEmailsAndNames

admin.users.
getSpamUsers

Get a list of emails of spam users
output
array of
string

admin.users.
removeSpamUsers

Remove spam users
input
array of
string

admin.dashboard

admin.dashboard.
getAll

Get all admin dashboard items.
output
AdminDashboard

admin.dashboard.
getDatabasesInfo

Get database info.
output
DatabasesInfo

admin.dashboard.
getFreeDiskSpace

Get free disk space.
output
FreeDiskSpace

admin.dashboard.
getRecentConnectedUsers

Get recent connected users.
output
RecentConnectedUsers

admin.dashboard.
getRecentLoadAverages

Get recent load averages.
output
RecentLoadAverages

admin.dashboard.
getRecentSubmissions

Get recent submissions.
output
RecentSubmissions

admin.dashboard.
getSubmissionsHistograms

Get submissions histograms.
output
SubmissionsHistograms

admin.dashboard.
getZombies

Get zombies.
output
Zombies

admin.dashboard.
getUpcomingExams

Get upcoming exams
input
daysBefore
integer
daysAfter
integer
output
UpcomingExams

admin.dashboard.
getPM2Status

Get pm2 status

This endpoint retrieves the status of PM2 processes as reported by `pm2 jlist`.

output

admin.dashboard.
getDockerStatus

Get docker status

This endpoint retrieves the status of docker processes as reported by `docker ps --all`.

output

admin.queue

admin.queue.
getQueue

Get the lattest submissions from the queue in descending chronological order for a certain verdict.

The `limit` parameter tells the number of submissions to retrieve. The `verdicts` parameter is an array of verdicts to filter the submissions. If no verdicts are provided, all submissions will be retrieved.

input
QueueQuery
output
SubmissionQueueItems

admin.tasks

admin.tasks.
purgeAuthTokens

Purge expired access tokens.

Purge expired access tokens (call it from time to time, it does not hurt)

admin.tasks.
clearCaches

Clear all memoization caches.

admin.tasks.
fatalizeIEs

Fatalize IE submissions.

admin.tasks.
fatalizePendings

Fatalize pending submissions.

admin.tasks.
resubmitIEs

Resubmit IE submissions.

admin.tasks.
resubmitPendings

Resubmit pending submissions.

admin.tasks.
getFullTextSearchDatabase

Get full text search database status.
output filesone

admin.tasks.
updateSemanticSearchDatabase

Update semantic search database.
input
string
input filesone

admin.stats

admin.stats.
getCounters

Get counters.
output
dict of
number

admin.stats.
getDistributionOfVerdicts

Get distribution of verdicts.
output
dict of
number

admin.stats.
getDistributionOfVerdictsByYear

Get distribution of verdicts by year.
output
array of
dict of
number

admin.stats.
getDistributionOfCompilers

Get distribution of compilers.
output
dict of
number

admin.stats.
getDistributionOfProglangs

Get distribution of proglangs.
output
dict of
number

admin.stats.
getDistributionOfUsersByYear

Get distribution of registered users by year.
output
dict of
number

admin.stats.
getDistributionOfUsersByCountry

Get distribution of registered users by country.
output
dict of
number

admin.stats.
getDistributionOfUsersBySubmissions

Get distribution of registered users by submissions using a custom bucket size.
input
integer
output
dict of
number

admin.stats.
getRankingOfUsers

Get ranking of users.
input
integer
output
UserRanking

admin.stats.
getDistributionOfSubmissionsByHour

Get distribution of submissions by hour.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByProglang

Get distribution of submissions by proglang.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByCompiler

Get distribution of submissions by compiler.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByWeekday

Get distribution of submissions by weekday.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByYear

Get distribution of submissions by year.
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByYearForProglang

Get distribution of submissions by year for a proglang.
input
string
output
dict of
number

admin.stats.
getDistributionOfSubmissionsByDay

Get distribution of submissions by day.
output
dict of
number

admin.stats.
getHeatmapCalendarOfSubmissions

Get heatmap calendar of submissions.
input
DateRange
output

admin.stats.
getDistributionOfDomains

Get distribution of domains of users' emails.
output
dict of
number

admin.problems

admin.problems.
getProblemSummary

Get summary for a problem.
input
string
output
ProblemSummary
or
null

admin.problems.
getProblemsWithSummary

Get list of problems with summary.
output
array of
string

admin.problems.
getProblemsWithoutSummary

Get list of problems without summary.
output
array of
string

admin.problems.
getAbstractProblemSolutionTags

Get solution tags for an abstract problem.
input
problem_nm
string
output
SolutionTags
or
null

admin.problems.
getAbstractProblemsWithSolutionTags

Get list of abstract problems with solution tags.
output
array of
string

admin.problems.
getAbstractProblemsWithoutSolutionTags

Get list of abstract problems without solution tags.
output
array of
string

testing.check

testing.check.
checkUser

Checks that query actor is a user.

testing.check.
checkInstructor

Checks that query actor is an instructor.

testing.check.
checkAdmin

Checks that query actor is an admin.

testing.check.
throwError

Throw an exception of the given type.
input
string

testing.playground

testing.playground.
upload

Upload a file.
input
Name
input filesone
output
string

testing.playground.
negate

Get negative of an image.
input filesone
output filesone

testing.playground.
download

Download a file.
input
Name
output filesone

testing.playground.
download2

Download a file with a string.
input
Name
output
string
output filesone

testing.playground.
ping

Ping the server to get a pong string.
output
string

testing.playground.
toUpperCase

Returns the given string in uppercase.
input
string
output
string

testing.playground.
add2i

Returns the sum of two integers.
input
TwoInts
output
integer

testing.playground.
add2f

Returns the sum of two floats.
input
TwoFloats
output
number

testing.playground.
inc

increment two numbers.
input
TwoInts
output
TwoInts

testing.playground.
add3i

Returns the sum of three integers.
input
a
integer
b
integer
c
integer
output
integer

testing.playground.
something

Returns a type with defaults.
input
SomeType
output
SomeType

testing.playground.
clock

Get a webstream with clok data.
output
WebStream