Judge0 CE - API Docs

About

Judge0 is a robust, scalable, and open-source online code execution system. You can use it to build a wide range of applications that need online code execution features. Some examples include competitive programming platforms, e-learning platforms, candidate assessment and recruitment platforms, online code editors, online IDEs, and many more.

In our research paper Robust and Scalable Online Code Execution System, we present Judge0’s modern modular architecture that can be easily deployed and scaled. We study its design, comment on the various challenges in building such systems, and compare it with other available online code execution systems and online judge systems.

To see Judge0 in action, try Judge0 IDE - our free and open-source online code editor. You can also try using a dummy client that can help you explore and test most of the features of Judge0.

Easily integrate online code editor with code execution (a.k.a. online compiler) to your website with our embeddable web widgets.

Get Started

You can find our detailed plans and pricing here.

Why should you use Judge0 on RapidAPI?

Our infrastructure allows you to focus on building your product and forget about the know-how of maintaining and scaling Judge0.

Donate

Your are more than welcome to support Judge0 development on Patreon, via PayPal or Revolut. Thank you.

Authentication ¶

Administrators of Judge0 can configure Judge0 to require you to have an authentication token (a.k.a. API key). If that is the case with the instance of Judge0 you are using, then you should provide X-Auth-Token header field in every API request.

@@ -103,7 +81,7 @@

Donate Although you can send authentication token as URI parameter, always send authentication token through headers.

If your authentication token is valid or authentication is disabled. +

Example URI

POST https://extra-ce.judge0.com/authenticate

Request

HideShow

Headers

X-Auth-Token: f6583e60-b13b-4228-b554-2eb332ca64e7

Response 200

HideShow

If your authentication token is valid or authentication is disabled. If authentication is disabled you do not need an authentication token.

Response 401

HideShow

Authentication failed because your authentication token is invalid.

Authorization ¶

To issue some API calls you need to be authorized. For example, you need to be authorized to @@ -128,7 +106,7 @@

Example URI

POSTAlthough you can send authorization token as URI parameter, always send authorization token through headers.

Example URI

POST https://ce.judge0.com/authorize

Request

HideShow

Headers

X-Auth-User: a1133bc6-a0f6-46bf-a2d8-6157418c6fe2

Response 200

HideShow

If your authorization token is valid.

Example URI

POST https://extra-ce.judge0.com/authorize

Request

HideShow

Headers

X-Auth-User: a1133bc6-a0f6-46bf-a2d8-6157418c6fe2

Response 200

HideShow

If your authorization token is valid.

Response 401

HideShow

Authentication failed. Please read about authentication process.

Response 403

HideShow

Authorization failed because your authorization token is invalid.

Submissions ¶

Submission ¶

Submission is used for running arbitrary source code in one of @@ -426,7 +404,7 @@

Multi-file programs Multi-file programs are available since v1.10.0 and they allow you specify your own compilation and execution scripts that Judge0 will use.

To use multi-file program feature you need to choose a language called Multi-file program whoose ID is 89. Moreover, you need to send all program files with additional_files attribute. With multi-file programs attribute source_code cannot be used, i.e. all files should be sent with additional_files attribute.

As mentioned in the table above, additional_files attribute should be a content of a Base64 encoded .zip archive. This archive will be extracted in the sandbox before compilation and execution.

For the Judge0 to know how to compile and execute your multi-file program you need to provide two special files that should be available in the root of the .zip archive that you are sending with additional_files attribute. These files should be named compile and run, and are expected to be Bash scripts that know how to compile and execute your multi-file program. If your multi-file program does not need compilation step, then you don’t need to provide compile script. Take a look at this example to learn how to use this feature to compile and run multi-file C++ project that uses CMake.

Create a Submission
POST`/submissions/{?base64_encoded,wait}`

Creates new submission. Created submission waits in queue to be processed. On successful creation, you are returned submission token which can be used to check submission status.

If submission’s source_code, stdin or expected_output contains non printable characters, or @@ -443,7 +421,7 @@

Multi-file programs We do not recommend the use of `wait=true` feature because it does not scale well.

Example URI

POST https://ce.judge0.com/submissions/?base64_encoded=false&wait=false

URI Parameters

HideShow

base64_encoded

boolean (optional) Default: false Example: false

Set to true if you want to send Base64 encoded data to Judge0.

Example URI

POST https://extra-ce.judge0.com/submissions/?base64_encoded=false&wait=false

URI Parameters

HideShow

base64_encoded: boolean (optional) Default: false Example: false
Set to true if you want to send Base64 encoded data to Judge0.
wait: boolean (optional) Default: false Example: false
Set to true to immediately get submission result.

Request

HideShow

Headers

Content-Type: application/json

Body

{
   "source_code": "#include <stdio.h>\n\nint main(void) {\n  char name[10];\n  scanf(\"%s\", name);\n  printf(\"hello, %s\n\", name);\n  return 0;\n}",
@@ -527,7 +505,7 @@ Example URI
POST

`Get a Submission`
`GET/submissions/{token}{?base64_encoded,fields}`

Returns details about submission.


 Just like in create submission you can receive Base64 encoded data for every text type attribute (check the table to see which attributes are text type). By default, this parameter is set to false and Judge0 will send you raw data.
 By default Judge0 is sending 8 attributes for submission. By sending fields query parameter you can specify exactly which attributes you want from Judge0. Special value * will return all available attributes.
-Example URI
GET https://ce.judge0.com/submissions/d85cd024-1548-4165-96c7-7bc88673f194?base64_encoded=false&fields=stdout,stderr,status_id,language_id
URI ParametersHideShow
token
string (required) Example: d85cd024-1548-4165-96c7-7bc88673f194Token of submission. You got this token when you created submission.
+Example URI
GET https://extra-ce.judge0.com/submissions/d85cd024-1548-4165-96c7-7bc88673f194?base64_encoded=false&fields=stdout,stderr,status_id,language_id
URI ParametersHideShow
token
string (required) Example: d85cd024-1548-4165-96c7-7bc88673f194Token of submission. You got this token when you created submission.
 
base64_encoded
boolean (optional) Example: falseSet to true if you want to receive Base64 encoded data from Judge0. You should set this to true if you expect the program’s stdout to contain non-printable characters or if you expect the compiler to output non-printable characters during a compile error (GCC does this, for instance).
 
fields
string (optional) Default: stdout,time,memory,stderr,token,compile_output,message,status Example: stdout,stderr,status_id,language_idReturn only the desired attributes.
 
Response  200HideShow
Headers
Content-Type: applicatiion/json
Body
{
@@ -564,7 +542,7 @@ Example URIGET&
 }
Response  400HideShow
Headers
Content-Type: application/json
Body
{
   "error": "some attributes for this submission cannot be converted to UTF-8, use base64_encoded=true query parameter"
 }
Response  401HideShow
Authentication failed. Please read about authentication process.
-
Get Submissions
GET/submissions/{?base64_encoded,fields,page,per_page}
Example URI
GET https://ce.judge0.com/submissions/?base64_encoded=false&fields=status,language,time&page=4&per_page=2
URI ParametersHideShow
base64_encoded
boolean (optional) Default: false Example: falseSet to true if you want to receive Base64 encoded data from Judge0.
+

`Get Submissions`
`GET/submissions/{?base64_encoded,fields,page,per_page}`

`Example URI`

GET https://extra-ce.judge0.com/submissions/?base64_encoded=false&fields=status,language,time&page=4&per_page=2

URI ParametersHideShow

base64_encoded

boolean (optional) Default: false Example: falseSet to true if you want to receive Base64 encoded data from Judge0.

page

integer (optional) Default: 1 Example: 4Pagination page number.

per_page

integer (optional) Default: 20 Example: 2Number of submissions to return per page.

fields

string (optional) Default: stdout,time,memory,stderr,token,compile_output,message,status Example: status,language,timeReturn only the desired attributes.
@@ -653,7 +631,7 @@ Example URI
GET&
 you are using disallowed submission deletion. So before using this feature please check configuration of Judge0 you are using.
 For this request query parameter base64_encoded is implicitly set to true and cannot be changed.
 This guarantees you will successfully get requested submission attributes after deletion.
-Example URI
DELETE https://ce.judge0.com/submissions/d85cd024-1548-4165-96c7-7bc88673f194?fields=stdout,stderr,status_id,language_id
URI ParametersHideShow
token
string (required) Example: d85cd024-1548-4165-96c7-7bc88673f194Token of submission. You got this token when you created submission.
+Example URI
DELETE https://extra-ce.judge0.com/submissions/d85cd024-1548-4165-96c7-7bc88673f194?fields=stdout,stderr,status_id,language_id
URI ParametersHideShow
token
string (required) Example: d85cd024-1548-4165-96c7-7bc88673f194Token of submission. You got this token when you created submission.
 
fields
string (optional) Default: stdout,time,memory,stderr,token,compile_output,message,status Example: stdout,stderr,status_id,language_idReturn only the desired attributes.
 
Response  200HideShow
Headers
Content-Type: applcation/json
Body
{
   "stdout": "aGVsbG8sIHdvcmxkCg==\n",
@@ -673,7 +651,7 @@ Example URIDELETE}
Response  401HideShow
Authentication failed. Please read about authentication process.
 
Response  403HideShow
Authorization failed. Please read about authorization process.
 
Submission Batch  ¶
Create a Submission Batch
POST/submissions/batch{?base64_encoded}
Create multiple submissions at once.
-Example URI
POST https://ce.judge0.com/submissions/batch?base64_encoded=false
URI ParametersHideShow
base64_encoded
boolean (optional) Default: false Example: falseSet to true if you are sending Base64 encoded data.
+Example URI
POST https://extra-ce.judge0.com/submissions/batch?base64_encoded=false
URI ParametersHideShow
base64_encoded
boolean (optional) Default: false Example: falseSet to true if you are sending Base64 encoded data.
 
RequestHideShow
Headers
Content-Type: application/json
Body
{
   "submissions": [
     {
@@ -729,7 +707,7 @@ Example URIPOST}
 ]
Get a Submission Batch
GET/submissions/batch{?tokens,base64_encoded,fields}
Get multiple submissions at once.
-Example URI
GET https://ce.judge0.com/submissions/batch?tokens=db54881d-bcf5-4c7b-a2e3-d33fe7e25de7,ecc52a9b-ea80-4a00-ad50-4ab6cc3bb2a1,1b35ec3b-5776-48ef-b646-d5522bdeb2cc&base64_encoded=false&fields=token,stdout,stderr,status_id,language_id
URI ParametersHideShow
tokens
string (required) Example: db54881d-bcf5-4c7b-a2e3-d33fe7e25de7,ecc52a9b-ea80-4a00-ad50-4ab6cc3bb2a1,1b35ec3b-5776-48ef-b646-d5522bdeb2ccSubmission tokens separeted with ,.
+Example URI
GET https://extra-ce.judge0.com/submissions/batch?tokens=db54881d-bcf5-4c7b-a2e3-d33fe7e25de7,ecc52a9b-ea80-4a00-ad50-4ab6cc3bb2a1,1b35ec3b-5776-48ef-b646-d5522bdeb2cc&base64_encoded=false&fields=token,stdout,stderr,status_id,language_id
URI ParametersHideShow
tokens
string (required) Example: db54881d-bcf5-4c7b-a2e3-d33fe7e25de7,ecc52a9b-ea80-4a00-ad50-4ab6cc3bb2a1,1b35ec3b-5776-48ef-b646-d5522bdeb2ccSubmission tokens separeted with ,.
 
base64_encoded
boolean (optional) Default: false Example: falseSet to true if you want to receive Base64 encoded data.
 
fields
string (optional) Default: stdout,time,memory,stderr,token,compile_output,message,status Example: token,stdout,stderr,status_id,language_idReturn only the desired attributes.
 
Response  200HideShow
Headers
Content-Type: application/json
Body
{
@@ -757,7 +735,7 @@ Example URIGET&
     }
   ]
 }

`Statuses and Languages ¶`

`Language ¶`

`Get Languages`
`GET/languages/`

Get active languages.


-Example URI
GET https://ce.judge0.com/languages/
Response  200HideShow
Headers
Content-Type: application/json
Body
[
+Example URI
GET https://extra-ce.judge0.com/languages/
Response  200HideShow
Headers
Content-Type: application/json
Body
[
   {
     "id": 45,
     "name": "Assembly (NASM 2.14.02)"
@@ -886,7 +864,7 @@ Example URIGET&
     "id": 74,
     "name": "TypeScript (3.7.4)"
   }
-]
Get a Language
GET/languages/{id}
Example URI
GET https://ce.judge0.com/languages/1
URI ParametersHideShow
id
integer (required) Example: 1Language ID.
+]
Get a Language
GET/languages/{id}
Example URI
GET https://extra-ce.judge0.com/languages/1
URI ParametersHideShow
id
integer (required) Example: 1Language ID.
 
Response  200HideShow
Headers
Content-Type: application/json
Body
{
   "id": 1,
   "name": "Bash (4.4)",
@@ -895,7 +873,7 @@ Example URIGET&
   "compile_cmd": null,
   "run_cmd": "/usr/local/bash-4.4/bin/bash script.sh"
 }

`Active and Archived Languages ¶`

`Get Active and Archived Languages`
`GET/languages/all`

Get active and archived languages.


-Example URI
GET https://ce.judge0.com/languages/all
Response  200HideShow
Headers
Content-Type: application/json
Body
[
+Example URI
GET https://extra-ce.judge0.com/languages/all
Response  200HideShow
Headers
Content-Type: application/json
Body
[
   {
     "id": 45,
     "name": "Assembly (NASM 2.14.02)",
@@ -1266,7 +1244,7 @@ Example URIGET&
     "name": "TypeScript (3.7.4)",
     "is_archived": false
   }
-]
Status  ¶
Get Statuses
GET/statuses
Example URI
GET https://ce.judge0.com/statuses
Response  200HideShow
Headers
Content-Type: application/json
Body
[
+]
Status  ¶
Get Statuses
GET/statuses
Example URI
GET https://extra-ce.judge0.com/statuses
Response  200HideShow
Headers
Content-Type: application/json
Body
[
   {
     "id": 1,
     "description": "In Queue"
@@ -1338,7 +1316,7 @@ Example URI
GET&
 different hosts with different system configurations. Result of this API request is always from web system.
 This means that this request might be irrelevant to you if you as user don’t know if web and worker are
 hosted on the same machine. To find that out, please contact admins who host Judge0 you are using.
-Example URI
GET https://ce.judge0.com/system_info
Response  200HideShow
Headers
Content-Type: application/json
Body
{
+Example URI
GET https://extra-ce.judge0.com/system_info
Response  200HideShow
Headers
Content-Type: application/json
Body
{
   "Architecture": "x86_64",
   "CPU op-mode(s)": "32-bit, 64-bit",
   "Byte Order": "Little Endian",
@@ -1634,7 +1612,7 @@ Example URI
GET&
 
 
 For example, max_cpu_time_limit with value 20 means that user cannot create new submission which has cpu_time_limit greater than 20.
-Example URI
GET https://ce.judge0.com/config_info
Response  200HideShow
Headers
Content-Type: application/json
Body
{
+Example URI
GET https://extra-ce.judge0.com/config_info
Response  200HideShow
Headers
Content-Type: application/json
Body
{
   "enable_wait_result": true,
   "enable_compiler_options": true,
   "allowed_languages_for_compile_options": [],
@@ -1662,7 +1640,7 @@ Example URIGET&
   "number_of_runs": 1,
   "max_number_of_runs": 20
 }

`Statistics ¶`

`Statistics`
`GET/statistics`

Get some statistics from current instance. Result is cached for 10 minutes.


-Example URI
GET https://ce.judge0.com/statistics
URI ParametersHideShow
invalidate_cache
boolean (optional) Example: falseSet to true if you want to invalidate current cache and fetch new statistics.
+Example URI
GET https://extra-ce.judge0.com/statistics
URI ParametersHideShow
invalidate_cache
boolean (optional) Example: falseSet to true if you want to invalidate current cache and fetch new statistics.

`Health Check ¶`

`Workers ¶`

`Workers`
`GET/workers`

For each queue you will get:


 
 
@@ -1687,7 +1665,7 @@ Example URI
GET&
 how many jobs failed
 
 
-Example URI
GET https://ce.judge0.com/workers
Response  200HideShow
Headers
Content-Type: application/json
Body
[
+Example URI
GET https://extra-ce.judge0.com/workers
Response  200HideShow
Headers
Content-Type: application/json
Body
[
   {
     "queue": "default",
     "size": 0,
@@ -1698,15 +1676,15 @@ Example URIGET&
     "failed": 0
   }
 ]

`Information ¶`

`About ¶`

`About`
`GET/about`

Returns general information.


-Example URI
GET https://ce.judge0.com/about
Response  200HideShow
Headers
Content-Type: application/json
Body
{
+Example URI
GET https://extra-ce.judge0.com/about
Response  200HideShow
Headers
Content-Type: application/json
Body
{
   "version": "1.5.0",
   "homepage": "https://judge0.com",
   "source_code": "https://github.com/judge0/judge0",
   "maintainer": "Herman Zvonimir Došilović <hermanz.dosilovic@gmail.com>"
 }
Version  ¶
Version
GET/version
Returns current version.

-Example URI
GET https://ce.judge0.com/version
Isolate  ¶
Isolate
GET/isolate
Returns result of isolate --version.

-Example URI
GET https://ce.judge0.com/isolate
License  ¶
License
GET/license
Returns a license.

-Example URI
GET https://ce.judge0.com/license

About ¶

Features ¶

Features Webhooks (HTTP callbacks)

Get Started ¶

Flavors You can find the source code for Judge0 CE on the master branch, while you can find the source code for Judge0 Extra CE on the extra branch. Judge0 Extra CE is also available on RapidAPI.

Version ¶

Date and time formats ¶

License ¶

Donate ¶

Authentication ¶

Donate Although you can send authentication token as URI parameter, always send authentication token through headers.

Example URI

Headers

Example URI

Headers

Authorization ¶

Example URI

Example URI

Headers

Example URI

Headers

Submissions ¶

Submission ¶

Create a SubmissionPOST/submissions/{?base64_encoded,wait}

Multi-file programs We do not recommend the use of wait=true feature because it does not scale well.

Example URI

Example URI

Headers

Body

Example URI

Get a SubmissionGET/submissions/{token}{?base64_encoded,fields}

Example URI

Example URI

Headers

Body

Example URI

Headers

Body

Get SubmissionsGET/submissions/{?base64_encoded,fields,page,per_page}

Example URI

Get SubmissionsGET/submissions/{?base64_encoded,fields,page,per_page}

Example URI

Example URI

Example URI

Example URI

Headers

Body

Example URI

Submission Batch ¶

Create a Submission BatchPOST/submissions/batch{?base64_encoded}

Example URI

Example URI

Headers

Body

Example URI

Get a Submission BatchGET/submissions/batch{?tokens,base64_encoded,fields}

Example URI

Example URI

Headers

Body

Example URI

Statuses and Languages ¶

Language ¶

Get LanguagesGET/languages/

Example URI

Headers

Body

Example URI

Headers

Body

Example URI

Get a LanguageGET/languages/{id}

Example URI

Get a LanguageGET/languages/{id}

Example URI

Headers

Body

Example URI

Active and Archived Languages ¶

Get Active and Archived LanguagesGET/languages/all

About

Features

Get Started

Flavors You can find the source code for Judge0 CE on the `master` branch, while you can find the source code for Judge0 Extra CE on the `extra` branch.

Judge0 Extra CE is also available on RapidAPI.

Version

Date and time formats

License

Donate

Create a Submission
POST`/submissions/{?base64_encoded,wait}`

Multi-file programs We do not recommend the use of `wait=true` feature because it does not scale well.

`Get a Submission`
`GET/submissions/{token}{?base64_encoded,fields}`

Get Submissions
GET`/submissions/{?base64_encoded,fields,page,per_page}`

`Get Submissions`
`GET/submissions/{?base64_encoded,fields,page,per_page}`

`Example URI`

Create a Submission Batch
POST`/submissions/batch{?base64_encoded}`

Get a Submission Batch
GET`/submissions/batch{?tokens,base64_encoded,fields}`

`Statuses and Languages ¶`

`Language ¶`

`Get Languages`
`GET/languages/`

`Get a Language`
`GET/languages/{id}`

`Example URI`

Get a Language
GET`/languages/{id}`

`Active and Archived Languages ¶`

`Get Active and Archived Languages`
`GET/languages/all`

`Status ¶`

`Get Statuses`
`GET/statuses`

`Example URI`

`Headers`

`Body`

`Status ¶`

`Get Statuses`
`GET/statuses`

`Example URI`

`Headers`

`Body`

`Statistics ¶`

`Statistics ¶`

`Statistics`
`GET/statistics`

`Health Check ¶`

`Workers ¶`

`Workers`
`GET/workers`

`Information ¶`

`About ¶`

`About`
`GET/about`

`Version ¶`

`Version`
`GET/version`

`Isolate ¶`

`Isolate`
`GET/isolate`

`License ¶`

`License`
`GET/license`