Skip to content

Record a run​

POST
/v1/run-records

Runs firmware on a free board of the given type and records it: the write, then everything the board prints for run_seconds (10 to 120, default 30), each frame with its time. send is written to the board once its new firmware has printed and gone quiet. The run is a session of yours and billed like one. The response comes back at once in state recording; the record turns ready, or failed with a reason, when the run ends. Anyone with the link can watch the recording; the "Run on SiliconRig" badge in the response links to it. A record cannot be changed; record a new one instead.

Authorizations​

BearerAuth

API key (Bearer key_...)

Type
API Key (header: Authorization)

Request Body​

multipart/form-data
object

Board type

Firmware, in the same formats a flash accepts

Format"binary"

Name shown with the recording (default: the file name)

How long to record, in seconds

Text written to the board after it boots (at most 256 bytes)

Responses​

Accepted

application/json
JSON
{
  
"badge_markdown": "string",
  
"board_id": "string",
  
"board_label": "string",
  
"board_type": "string",
  
"coordinator_version": "string",
  
"created_at": "string",
  
"error": "string",
  
"firmware_bytes": 0,
  
"firmware_sha256": "string",
  
"id": "string",
  
"name": "string",
  
"pod_version": "string",
  
"recorded_at": "string",
  
"run_seconds": 0,
  
"send": "string",
  
"state": "string",
  
"truncated": true,
  
"url": "string"
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI