API Documentation

All requests are POST.
If route is Authorized, send Authorization: Bearer <token> in headers.
On error, response will include an error field.
Webhook Request
When you provide a webhook URL for a job, Blaze Engineer will send a POST request to your webhook whenever the job status changes.
Request Body:
{
  "jobID": "string",
  "statusChange": "string" // One of the possible job status values
}
Fields:
  • jobID string – ID of the job whose status changed.
  • statusChange string – The new status for the job.
    Possible values: running pending codeReview failedCodeReview stopped gitCloneFailed gitSwitchBranchFailed ranOutOfCredits openAIDown systemError completed
Your webhook endpoint should accept POST requests with a JSON body in the above format.
Master File System
Blaze Engineer includes a Master File System designed to centralize and manage key files used for AI automation and code management. There are 7 master files in total.
  • Automatically generated master files:
    • databaseSchema
    • environmentVariableSchema
    • fileList
    • folderList
    These files are automatically updated during code syncs.
  • User-editable master files:
    • architectPatterns
    • environment
    • fixesToCommonMistakes
    These files can be edited manually by the user via the /masterFiles endpoints.
Allowed values for name (for editing/viewing):
architectPatterns, environment, fixesToCommonMistakes
Use the /masterFiles endpoints to edit, view, or list master files. See the endpoints above.
Jobs/Run - Code Sync Phase
When you run a job on a repository and branch. Before the Coding Phase is reached the Code Sync Phase is executed.

For the first job ran on a repository and branch the Initial Code Sync Phase can take a few minutes but future ran jobs on the same repository and branch will skip the Code Sync Phase and jump straight to the Coding Phase. Which will make any job ran after the initial ran job take less time and cost less credits to reach the Coding Phase.

Since the Code Sync Phase is usually the most expensive and time consuming phase. Working in the same repository and branch can save a ton of credits and time.
(Go To Top Of Page)