Report runtime usage

Deliver one sealed usage batch from an installed runtime (CLI credential; a condition of the SimForge account and download terms). A v2 batch is refused unless its agreementVersion is the account’s latest accepted agreement and lists the v2 records

POST /api/v1/telemetry

Report runtime usage

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/telemetry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema": "simforge.usage-batch/v1",
  "batchId": "<string>",
  "sealedAt": "<string>",
  "accountId": "<string>",
  "installId": "<string>",
  "machine": {
    "os": "<string>",
    "arch": "<string>",
    "gpus": [
      {
        "model": "<string>",
        "vramMib": 500000000000,
        "driver": "<string>"
      }
    ],
    "gpuCount": 8
  },
  "droppedEvents": 500000000000,
  "events": [
    {
      "eventId": "<string>",
      "finishedAt": "<string>",
      "runtimeVersion": "<string>",
      "cliVersion": "<string>",
      "command": "<string>",
      "sensors": 500000000000,
      "frames": 500000000000,
      "wallSeconds": 50000000,
      "gpuBusySeconds": 50000000,
      "errorCode": "<string>",
      "episodes": 500000000000,
      "envSteps": 500000000000,
      "sessionId": "<string>"
    }
  ]
}
'

200

{
  "schema": "simforge.usage-receipt/v1",
  "batchId": "<string>",
  "firstDelivery": true,
  "accepted": 1
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Body

application/json

Option 1

Option 2

schema · enum<string> · required

Available options: simforge.usage-batch/v1

batchId · string · required

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

sealedAt · string · required

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

accountId · string · required

Required string length: 1 - 128

installId · string · required

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

machine · object · required

Show child attributes

droppedEvents · integer · required

Required range: 0 <= x <= 1000000000000

events · object[] · required

Required array length: 1 - 500 elements

Show child attributes

Response

200

application/json

Stored, or already stored under this batch ID.

schema · enum<string> · required

Available options: simforge.usage-receipt/v1

batchId · string · required

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

firstDelivery · boolean · required

accepted · integer · required

Required range: x >= 0