1. Dispatch API
  2. Overview

Authentication

Please contact us via Discord or email for an API key.

To authenticate, provide your API as a bearer token in the Authorization header. For example, Authorization: Bearer BImPtQWrCnb7aceCdlGQ-qniBJFNH2-1tVv7OjoHuQA

Simple authentication request

Terminal

            
              
              
            
            
          curl -X POST \
    -H 'Authorization: Bearer BImPtQWrCnb7aceCdlGQ-qniBJFNH2-1tVv7OjoHuQA' \
    https://engine.hyperbeam.com/v0/vm

Install custom Chrome extension

With crx file


            
              
              
            
            
          curl -X POST \
  -H 'Authorization: Bearer <your-api-key>' \
  -H 'Content-Type: multipart/form-data' \
  https://engine.hyperbeam.com/v0/vm \
  --form 'body={"ublock":true,"extension":{"field":"ex"}}' \
  --form 'ex=@/tmp/ext.crx;type=application/x-chrome-extension'

With zip file


            
              
              
            
            
          curl -X POST \
  -H 'Authorization: Bearer <your-api-key>' \
  -H 'Content-Type: multipart/form-data' \
  https://engine.hyperbeam.com/v0/vm \
  --form 'body={"ublock":true,"extension":{"field":"ex"}}' \
  --form 'ex=@/tmp/ext.zip;type=application/zip'