Compiling Code

Create Compilation Job

Introduction

Asynchronously create a compile job request for a project.

Request

Project Id specifying project to build. The /compile/create API accepts requests in the following format:

CreateCompileRequest Model - Request to compile a project.
projectId integer
Project Id we wish to compile.
Example 
{
  "projectId": 0
}

Responses

The /compile/create API provides a response in the following format:

200 Success

CompileResponse Model - Response from the compiler on a build event.
compileId string
Compile Id for a sucessful build.
state string Enum
True on successful compile. Options : ['InQueue', 'BuildSuccess', 'BuildError']
projectId integer
Project Id we sent for compile.
signature string
Signature key of compilation.
signatureOrder string
Signature order of files to be compiled.
logs string Array
Logs of the compilation request.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "compileId": "string",
  "state": "InQueue",
  "projectId": 0,
  "signature": "string",
  "signatureOrder": "string",
  "logs": [
    "string"
  ],
  "success": true,
  "errors": [
    "string"
  ]
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: