Compiling Code

Read Compilation Result

Introduction

Read a compile packet job result.

Request

Read a compile result for a specific Project Id and Compile Id. The /compile/read API accepts requests in the following format:

ReadCompileRequest Model - Request to read a compile packet job.
projectId integer
Project Id we sent for compile.
compileId string
Compile Id returned during the creation request.
Example 
{
  "projectId": 0,
  "compileId": "string"
}

Responses

The /compile/read 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 Array
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: