Getting Started Guide

1. 1 Signup To Get Auth Token
   Create your Blaze Engineer account and get your authorization token for all further requests.
   Example: Signup API Request (using curl)

   Copy

   curl -X POST https://api.blaze.engineer/users/signup \
     -H "Content-Type: application/json" \
     -d '{"email": "you@example.com", "password": "YourSecretPassword123", "betaKey": "YOUR_BETA_KEY_HERE"}'

   Example Response

   {
     "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
   }

2. 2 Generate SSH Private Key
   Create a new SSH keypair that will be used to access your Git repositories.
   Linux / macOS

   Copy

   ssh-keygen -t ed25519 -C "your_email@example.com"

   Windows (Command Prompt / PowerShell)

   Copy

   ssh-keygen -t ed25519 -C "your_email@example.com"

   When prompted, choose a path (or accept the default) and optionally set a passphrase. This generates two files:
   id_ed25519 (private key) and id_ed25519.pub (public key).
3. 3 Add Generated SSH Private Key To Git Account
   Add your new SSH public key to your Git provider so Blaze Engineer can access your repositories.
   All Git Providers are supported.

   GitHub Example:

   1. Login to GitHub.
   2. Click your avatar → Settings.
   3. On the left, click SSH and GPG keys.
   4. Click New SSH key.
   5. Set a Title (e.g. "Blaze Engineer").
   6. Paste the content of id_ed25519.pub into the Key field.
   7. Click Add SSH key.

   For other providers (GitLab, Bitbucket, Azure, etc) refer to their documentation for adding SSH keys.
4. 4 Add Git Private Key
   Add your private SSH key (never the .pub file) to Blaze Engineer so it can authenticate with your Git provider.
   Example: Add Key API Request

   Copy

   curl -X POST https://api.blaze.engineer/keys/add \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <token>" \
     -d '{
       "name": "My GitHub Key",
       "key": "-----BEGIN OPENSSH PRIVATE KEY-----\nYOUR_PRIVATE_KEY_CONTENT\n-----END OPENSSH PRIVATE KEY-----"
     }'

   Example Response

   {
     "keyID": "abc123456789"
   }

5. 5 Add Repository
   Register your Git repository with Blaze Engineer, linking it to the SSH key you just added.
   Example: Add Repo API Request

   Copy

   curl -X POST https://api.blaze.engineer/repos/add \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <token>" \
     -d '{
       "name": "My Repo",
       "sshURL": "git@github.com:username/reponame.git",
       "keyID": "abc123456789"
     }'

   Example Response

   {
     "repoID": "repo_12345"
   }

6. 6 Run Job
   Start a new job on your repository by specifying which repo and branch to use and what task to perform.
   Example: Run Job API Request

   Copy

   curl -X POST https://api.blaze.engineer/jobs/run \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <token>" \
     -d '{
       "repoID": "repo_12345",
       "branch": "main",
       "task": "analyze-code"
     }'

   Example Response

   {
     "jobID": "job_98765",
     "status": "pending"
   }

7. 7 View Job
   View the status and details of your job.
   Example: View Job API Request

   Copy

   curl -X POST https://api.blaze.engineer/jobs/view \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <token>" \
     -d '{"id": "job_98765"}'

   Example Response

   {
     "id": "job_98765",
     "repoID": "repo_12345",
     "task": "analyze-code",
     "branch": "main",
     "status": "running",
     "createdAt": 1722451123
   }

   Status values: pending running completed stopped gitCloneFailed gitSwitchBranchFailed ranOutOfCredits openAIDown systemError